From a8a460545f53eaae3aec72c4d8355818fc6dd037 Mon Sep 17 00:00:00 2001 From: Matt Ickstadt Date: Thu, 2 Aug 2018 21:19:47 -0500 Subject: [PATCH] Update installation instructions in guide --- book-example/src/cli/README.md | 38 ++++++++++++++++++++++++++-------- 1 file changed, 29 insertions(+), 9 deletions(-) diff --git a/book-example/src/cli/README.md b/book-example/src/cli/README.md index bbd7964c..ca8e6de6 100644 --- a/book-example/src/cli/README.md +++ b/book-example/src/cli/README.md @@ -1,30 +1,49 @@ # Command Line Tool -mdBook can be used either as a command line tool or a [Rust crate](https://crates.io/crates/mdbook). -Let's focus on the command line tool capabilities first. +mdBook can be used either as a command line tool or a [Rust +crate](https://crates.io/crates/mdbook). Let's focus on the command line tool +capabilities first. -## Install +## Install From Binaries + +Precompiled binaries are provided for major platforms on a best-effort basis. +Visit [the releases page](https://github.com/rust-lang-nursery/mdBook/releases) +to download the appropriate version for your platform. + +## Install From Source + +mdBook can also be installed from source ### Pre-requisite -mdBook is written in **[Rust](https://www.rust-lang.org/)** and therefore needs to be compiled with **Cargo**, because we don't yet offer ready-to-go binaries. If you haven't already installed Rust, please go ahead and [install it](https://www.rust-lang.org/downloads.html) now. +mdBook is written in **[Rust](https://www.rust-lang.org/)** and therefore needs +to be compiled with **Cargo**. If you haven't already installed Rust, please go +ahead and [install it](https://www.rust-lang.org/downloads.html) now. ### Install Crates.io version -Installing mdBook is relatively easy if you already have Rust and Cargo installed. You just have to type this snippet in your terminal: +Installing mdBook is relatively easy if you already have Rust and Cargo +installed. You just have to type this snippet in your terminal: ```bash cargo install mdbook ``` -This will fetch the source code from [Crates.io](https://crates.io/) and compile it. You will have to add Cargo's `bin` directory to your `PATH`. +This will fetch the source code for the latest release from +[Crates.io](https://crates.io/) and compile it. You will have to add Cargo's +`bin` directory to your `PATH`. -Run `mdbook help` in your terminal to verify if it works. Congratulations, you have installed mdBook! +Run `mdbook help` in your terminal to verify if it works. Congratulations, you +have installed mdBook! ### Install Git version -The **[git version](https://github.com/rust-lang-nursery/mdBook)** contains all the latest bug-fixes and features, that will be released in the next version on **Crates.io**, if you can't wait until the next release. You can build the git version yourself. Open your terminal and navigate to the directory of you choice. We need to clone the git repository and then build it with Cargo. +The **[git version](https://github.com/rust-lang-nursery/mdBook)** contains all +the latest bug-fixes and features, that will be released in the next version on +**Crates.io**, if you can't wait until the next release. You can build the git +version yourself. Open your terminal and navigate to the directory of you +choice. We need to clone the git repository and then build it with Cargo. ```bash git clone --depth=1 https://github.com/rust-lang-nursery/mdBook.git @@ -32,4 +51,5 @@ cd mdBook cargo build --release ``` -The executable `mdbook` will be in the `./target/release` folder, this should be added to the path. +The executable `mdbook` will be in the `./target/release` folder, this should be +added to the path.