From 18f32f8b5600eff91ce7db87f1672255ade2b0fd Mon Sep 17 00:00:00 2001 From: Benjamin Bouvier Date: Fri, 28 Oct 2016 16:04:43 +0200 Subject: [PATCH] Add build instructions in the REAME; --- README.rst | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.rst b/README.rst index a80a23a283..1eb43c6981 100644 --- a/README.rst +++ b/README.rst @@ -36,6 +36,26 @@ Predictable performance the quirks of the target architecture. There are no advanced optimizations that sometimes work, somtimes fail. +Building Cretonne +----------------- + +Cretonne is using the Cargo package manager format. First, ensure you have +installed `rust 1.12.0` or above. Then, change the workind directory to your +clone of cretonne and run:: + + cargo build + +This will create a *target/debug* directory where you can find the generated +binary. + +To build the optimized binary for release:: + + cargo build --release + +You can then run tests with:: + + ./test-all.sh + Building the documentation --------------------------