From 0f5363679d582d4fddf4e047ff8806e1ebae533c Mon Sep 17 00:00:00 2001 From: Brooks J Rady Date: Tue, 16 Feb 2021 18:40:20 +0000 Subject: [PATCH] Add updated build instructions --- CONTRIBUTING.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7aa359f3..a58d52f9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,6 +13,16 @@ of contributions, and don't want a wall of rules to get in the way of that. 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. + +```sh +# An unoptimized debug build +./build-all.sh +# A fully optimized release build +./build-all.sh --release +``` + ## Looking for something to work on? If you are new contributor to `Zellij` going through [beginners][good-first-issue]