Skip to content

Add cargo install instructions to README #105

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 10, 2024
Merged

Add cargo install instructions to README #105

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down