diff options
| author | Brooks J Rady <b.j.rady@gmail.com> | 2021-04-13 16:06:04 +0100 |
|---|---|---|
| committer | Brooks J Rady <b.j.rady@gmail.com> | 2021-04-13 16:06:04 +0100 |
| commit | d2a7d100acdbcf85664fb10a04805325abd10a6c (patch) | |
| tree | 61923c53936e3ff9368064266de2a893d3b1d2a0 /CONTRIBUTING.md | |
| parent | dcd03ddc857fa35909de95d3dee9f01ad8344806 (diff) | |
docs(build): documented the new build system
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 26 |
1 files changed, 20 insertions, 6 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 45af4a8cb..9f12bc7fe 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,16 +14,30 @@ Before contributing please read our [Code of Conduct](CODE_OF_CONDUCT.md) which all contributors are expected to adhere to. ## Building -To work around a [Cargo bug][https://github.com/rust-lang/cargo/issues/7004], you'll need to use the included `build-all.sh` script. +To build Zellij, we're using cargo-make – you can install it by running `cargo install --force cargo-make`. + +Here are some of the commands currently supported by the build system: ```sh -# An unoptimized debug build -./build-all.sh -# A fully optimized release build -./build-all.sh --release +# Format code, build, then run tests +cargo make +# You can also perform these actions individually +cargo make format +cargo make build +cargo make test +# Run Zellij (optionally with a non-default layout) +cargo make run +cargo make run strider +# Run Clippy (potentially with additional options) +cargo make clippy +cargo make clippy -W clippy::pedantic +# Install Zellij to some directory +cargo make install /path/of/zellij/binary +# Publish the zellij and zellij-tile crates +cargo make publish ``` -The build script has an optional dependency on `binaryen --version` > 97, for it's command `wasm-opt`. +To run `install` or `publish`, you'll need `binaryen --version` > 97, for it's command `wasm-opt`. ## Looking for something to work on? |