From 199c07e97560c3901b43742a11417cd2761ce3dd Mon Sep 17 00:00:00 2001 From: Robin Avery Date: Mon, 9 Sep 2024 21:38:06 -0400 Subject: [PATCH] Add `cargo install` instructions to README (#105) --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 650c43c..f4a8efa 100644 --- a/README.md +++ b/README.md @@ -164,6 +164,17 @@ $ cd objdiff $ cargo run --release ``` +Or using `cargo install`. + +```shell +$ cargo install --git https://github.com/encounter/objdiff.git objdiff-gui +# or, for wgpu backend (recommended on macOS) +$ cargo install --git https://github.com/encounter/objdiff.git objdiff-gui --features wgpu + +# then run objdiff +$ objdiff +``` + ## License Licensed under either of