From cf3eb22ebcb33ae794edbfb32a4146f8b821ad2e 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` --- CHANGELOG.md | 2 ++ docs/install-and-setup.md | 14 ++++++++++++++ 2 files changed, 16 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index afa773d65d9..34e3cdae49a 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 77c8f7808a2..b7e79df1267 100644 --- a/docs/install-and-setup.md +++ b/docs/install-and-setup.md @@ -9,9 +9,23 @@ There are [pre-built binaries](https://github.com/martinvonz/jj/releases/latest) of the last released version of `jj` for Windows, Mac, or Linux (the "musl" 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 release binaries 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 compiled from +the same source code. + ### Linux