From 921890b222020c32cda3604c20af109f93783d72 Mon Sep 17 00:00:00 2001 From: Duke Leto Date: Sun, 27 Feb 2022 23:55:03 -0500 Subject: [PATCH] Make instructions more useful --- README.md | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index af58db6..24decab 100644 --- a/README.md +++ b/README.md @@ -37,23 +37,26 @@ git clone https://git.hush.is/hush/SilentDragonPaper Then choose one of these two source compilation options to build the SilentDragonPaper CLI. -#### Option 1: Compile using system installed rust -SilentDragonPaper is built with Rust. To compile from source, you must [install Rust 1.48](https://www.rust-lang.org/tools/install). +#### Recommended Option : Compile using "embedded" rust + +Here we do not need a system installed Rust to compile. The build.sh script pulls Rust version 1.48 down for us and builds with it. ``` -cd SilentDragonPaper/cli -cargo build --release +cd SilentDragonPaper +./build.sh ``` -#### Option 2: Compile using "embedded" rust +#### Advanced Option : Compile using system installed rust -Here we do not need a system installed Rust to compile. The build.sh script pulls Rust version 1.48 down for us and builds with it. +SilentDragonPaper is built with Rust. To compile from source, you must [install Rust 1.48](https://www.rust-lang.org/tools/install). +Older versions of Rust may work, newer versions will not. ``` -cd SilentDragonPaper -./build.sh +cd SilentDragonPaper/cli +cargo build --release ``` + #### Compiled binary location The completed binary is available in the `cli/target/release` folder.