From f3d8b316351a6b016e66afb2f4f2c36b559a1e7f Mon Sep 17 00:00:00 2001 From: a-kenji Date: Fri, 29 Jul 2022 18:59:50 +0200 Subject: [PATCH] fix(readme): cargo install instructions (#1616) --- CONTRIBUTING.md | 4 ++-- README.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index efdbb424..47437f16 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,9 +12,9 @@ all contributors are expected to adhere to. ## Building To build Zellij, we're using cargo-make – you can install it by running `cargo -install --force cargo-make`. +install --locked --force cargo-make`. -To edit our manpage, the mandown crate (`cargo install +To edit our manpage, the mandown crate (`cargo install --locked mandown`) is used and the work is done on a markdown file in docs/MANPAGE.md. Here are some of the commands currently supported by the build system: diff --git a/README.md b/README.md index e2c2d5a4..19d46d2f 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ Zellij was initially called "Mosaic". You can install with `cargo`: ``` -cargo install zellij +cargo install --locked zellij ``` Or if want to a prebuilt binary, you can download it from our [Releases](https://github.com/zellij-org/zellij/releases), or use [`cargo-binstall`](https://github.com/ryankurte/cargo-binstall). @@ -78,7 +78,7 @@ To get started, you can: ## How do I start a development environment? * Clone the project -* Install cargo-make with `cargo install --force cargo-make` +* Install cargo-make with `cargo install --locked --force cargo-make` * In the project folder, for debug builds run: `cargo make run` * To run all tests: `cargo make test`