summaryrefslogtreecommitdiffstats
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
parentba99c379cc6d47415f883142c4053faf0197c880 (diff)
simplifications
-rw-r--r--CONTRIBUTING.md4
-rw-r--r--Cargo.toml1
-rw-r--r--Makefile.toml6
3 files changed, 3 insertions, 8 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`.
diff --git a/Cargo.toml b/Cargo.toml
index 24fb4d924..242492729 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -48,7 +48,6 @@ features = ["unstable"]
[dev-dependencies]
insta = "1.6.0"
tempfile = "3.2.0"
-mandown = "0.1.2"
[build-dependencies]
structopt = "0.3"
diff --git a/Makefile.toml b/Makefile.toml
index 86543f6d9..b4821278e 100644
--- a/Makefile.toml
+++ b/Makefile.toml
@@ -131,9 +131,3 @@ args = ["publish"]
description = "Use mandown crate to create or update man entry from docs/MANPAGES.md"
workspace = false
script = "mandown docs/MANPAGE.md ZELLIJ 1 > assets/man/zellij.1"
-
-[tasks.manpage-install]
-description = "Install manpage from assets"
-workspace = false
-command = "sudo"
-args = ["cp", "assets/man/zellij.1", "/usr/share/man/man1/"]