From 10727543ac82371fd4c1232f861529e5f5ace41e Mon Sep 17 00:00:00 2001 From: Robin Avery Date: Mon, 9 Sep 2024 20:08:05 -0400 Subject: [PATCH] Add `cargo install` instructions to README --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 0607998c..402ac2c1 100644 --- a/README.md +++ b/README.md @@ -147,6 +147,17 @@ $ cargo run --release $ cargo run --release --features wgpu ``` +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