From 38daa9abe326427565bf5ea20a6373b59e2ebe7f Mon Sep 17 00:00:00 2001 From: Ilya Grigoriev Date: Tue, 19 Sep 2023 22:54:42 -0700 Subject: [PATCH] install-and-setup.md: Document binary installation with `cargo-binstall` I also mentioned this in the changelog, since people reading it are more likely to use `binstall` than most. --- CHANGELOG.md | 2 ++ docs/install-and-setup.md | 13 +++++++++++++ 2 files changed, 15 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7e0bdba8f..77abdb96d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -52,6 +52,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### New features +* `jj`'s stable release can now be installed with [`cargo binstall jj-cli`](https://github.com/cargo-bins/cargo-binstall). + * `jj workspace add` now takes a `--revision` argument. * `jj workspace forget` can now forget multiple workspaces at once. diff --git a/docs/install-and-setup.md b/docs/install-and-setup.md index 77c8f7808..883f187a2 100644 --- a/docs/install-and-setup.md +++ b/docs/install-and-setup.md @@ -12,6 +12,19 @@ version should work on all distributions). If you'd like to install a prerelease version, you'll need to use one of the options below. +#### Cargo BInstall + +If you use [`cargo-binstall`](https://github.com/cargo-bins/cargo-binstall), you +can install the same binaries of the last `jj` release from GitHub as follows: + +```shell +# Will put the jj binary for the latest release in ~/.cargo/bin by default +cargo binstall --strategy crate-meta-data jj-cli +``` + +Without the `--strategy` option, you may get equivalent binaries that should be +compiled from the same source code. + ### Linux