summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorNKGoc <natka.goc@gmail.com>2021-05-05 12:05:05 +0200
committerNKGoc <natka.goc@gmail.com>2021-05-05 12:05:05 +0200
commit0ab7a51d04ae195dc894a196beba3d9813fbf0f6 (patch)
treeefadb39686a8674ac3ffe79202f040ef780b9ea1 /CONTRIBUTING.md
parentba99c379cc6d47415f883142c4053faf0197c880 (diff)
simplifications
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 96659dce4..5294e5017 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -14,7 +14,7 @@ Before contributing please read our [Code of Conduct](CODE_OF_CONDUCT.md) which
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`.
+To build Zellij, we're using cargo-make – you can install it by running `cargo install --force cargo-make`. To edit a manpage mandown crate (`cargo install mandown`) is used and the work is done on a markdown file in docs/MANPAGE.md.
Zellij has a hard dependency on a package from `x11` most likely called `libX11`, or similarly on your system.
@@ -37,6 +37,8 @@ cargo make clippy -W clippy::pedantic
cargo make install /path/of/zellij/binary
# Publish the zellij and zellij-tile crates
cargo make publish
+# Update manpage
+cargo make manpage
```
To run `install` or `publish`, you'll need `binaryen --version` > 97, for it's command `wasm-opt`.