summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorBrooks J Rady <b.j.rady@gmail.com>2021-04-13 16:06:04 +0100
committerBrooks J Rady <b.j.rady@gmail.com>2021-04-13 16:06:04 +0100
commitd2a7d100acdbcf85664fb10a04805325abd10a6c (patch)
tree61923c53936e3ff9368064266de2a893d3b1d2a0 /README.md
parentdcd03ddc857fa35909de95d3dee9f01ad8344806 (diff)
docs(build): documented the new build system
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/README.md b/README.md
index f9bc9fe04..004ac9eab 100644
--- a/README.md
+++ b/README.md
@@ -30,12 +30,16 @@ Zellij was initially called "Mosaic".
## How to use it?
* Clone the project
-* In the project folder, run: `./build-all.sh && cargo run`
+* 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`
(note that right now Zellij only supports linux and mac)
The status bar on the bottom should guide you through the possible keyboard shortcuts in the app.
+For more build commands, take a look at [`Contributing.md`](CONTRIBUTING.md).
+
# What is the current status of the project?
Zellij is in the last stages of being VT compatible. As much as modern terminals are.