aboutsummaryrefslogtreecommitdiff
path: root/book/src/install.md
diff options
context:
space:
mode:
authorMichal Melewski2023-01-08 03:55:35 +0000
committerGitHub2023-01-08 03:55:35 +0000
commita39a2ce9a8dbf0f0e44073c8a2849a4c1dfc12ef (patch)
treeb37d84734bff96e1024e978fb1e7d3aa619af409 /book/src/install.md
parent95d4fdc255cc880b5dbcb91851eb53ffe2cfce97 (diff)
book: Recommend '--locked' for cargo installs (#5438)
Diffstat (limited to 'book/src/install.md')
-rw-r--r--book/src/install.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/book/src/install.md b/book/src/install.md
index 92097cfa..bf0ff079 100644
--- a/book/src/install.md
+++ b/book/src/install.md
@@ -94,7 +94,7 @@ pacman -S mingw-w64-ucrt-x86_64-helix
```
git clone https://github.com/helix-editor/helix
cd helix
-cargo install --path helix-term
+cargo install --path helix-term --locked
```
This will install the `hx` binary to `$HOME/.cargo/bin` and build tree-sitter grammars in `./runtime/grammars`.
@@ -127,7 +127,7 @@ mklink /D runtime "<helix-repo>\runtime"
The runtime location can be overridden via the `HELIX_RUNTIME` environment variable.
-> NOTE: if `HELIX_RUNTIME` is set prior to calling `cargo install --path helix-term`,
+> NOTE: if `HELIX_RUNTIME` is set prior to calling `cargo install --path helix-term --locked`,
> tree-sitter grammars will be built in `$HELIX_RUNTIME/grammars`.
If you plan on keeping the repo locally, an alternative to copying/symlinking