Browse Source

Make instructions more useful

master
Duke Leto 2 years ago
parent
commit
921890b222
  1. 19
      README.md

19
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. Then choose one of these two source compilation options to build the SilentDragonPaper CLI.
#### Option 1: Compile using system installed rust #### Recommended Option : Compile using "embedded" rust
SilentDragonPaper is built with Rust. To compile from source, you must [install Rust 1.48](https://www.rust-lang.org/tools/install).
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 cd SilentDragonPaper
cargo build --release ./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 cd SilentDragonPaper/cli
./build.sh cargo build --release
``` ```
#### Compiled binary location #### Compiled binary location
The completed binary is available in the `cli/target/release` folder. The completed binary is available in the `cli/target/release` folder.

Loading…
Cancel
Save