zellij-org/zellij
1
1
Fork 0
mirror of https://github.com/zellij-org/zellij.git synced 2024-12-24 01:34:38 +03:00
Code Issues Projects Releases Wiki Activity

fix(readme): cargo install instructions (#1616)

Browse Source
This commit is contained in:
a-kenji 2022-07-29 18:59:50 +02:00 committed by GitHub
parent 98c5c447bb
commit f3d8b31635
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CONTRIBUTING.md
View File

@ -12,9 +12,9 @@ all contributors are expected to adhere to.
## Building ## Building
To build Zellij, we're using cargo-make – you can install it by running `cargo 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. 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: Here are some of the commands currently supported by the build system:

4
README.md
View File

@ -42,7 +42,7 @@ Zellij was initially called "Mosaic".
You can install with `cargo`: 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). 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? ## How do I start a development environment?
* Clone the project * 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` * In the project folder, for debug builds run: `cargo make run`
* To run all tests: `cargo make test` * To run all tests: `cargo make test`