docs(build): update CONTRIBUTING.md

This commit is contained in:
Brooks J Rady 2021-04-14 19:11:24 +01:00
parent af702b67e6
commit a52aa9be97
2 changed files with 2 additions and 3 deletions

View file

@ -25,9 +25,9 @@ cargo make
cargo make format cargo make format
cargo make build cargo make build
cargo make test cargo make test
# Run Zellij (optionally with a non-default layout) # Run Zellij (optionally with additional arguments)
cargo make run cargo make run
cargo make run strider cargo make run -- -l strider
# Run Clippy (potentially with additional options) # Run Clippy (potentially with additional options)
cargo make clippy cargo make clippy
cargo make clippy -W clippy::pedantic cargo make clippy -W clippy::pedantic

View file

@ -31,7 +31,6 @@ Zellij was initially called "Mosaic".
## How to use it? ## How to use it?
* Clone the project * Clone the project
* Install cargo-make with `cargo install --force cargo-make` * Install cargo-make with `cargo install --force cargo-make`
* Make sure that the `~/.cargo/bin` directory is on your PATH
* In the project folder, run: `cargo make run` * In the project folder, run: `cargo make run`
(note that right now Zellij only supports linux and mac) (note that right now Zellij only supports linux and mac)