summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
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 203de8ccf..8b05e1f58 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).
+
# Configuration
It is possible to configure keyboard shortcuts and their actions in a yaml file.
An example file can be found under `example/config.yaml`.