actions
/
mdBook
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update installation instructions in the README 

Closes #123
This commit is contained in:
Mathieu David 2016-03-22 14:06:32 +01:00
parent c5752620d7
commit d0e39f469a
1 changed files with 30 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
README.md
View File

@ -23,8 +23,8 @@
mdBook is a utility to create modern online books from markdown files. mdBook is a utility to create modern online books from markdown files.
**This project is still in its early days.** **This project is still evolving.**
For more information about what is left on my to-do list, check the issue tracker For more information, check the issue tracker.
## What does it look like? ## What does it look like?
@ -33,34 +33,40 @@ The [**Documentation**](http://azerupi.github.io/mdBook/) for mdBook has been wr
## Installation ## Installation
There are 2 ways to install mdBook but both require [Rust and Cargo](https://www.rust-lang.org/) to be installed. There are multiple ways to install mdBook.
##### Install from Crates.io 1. **Binaries**
Binaries are available for download [here](https://github.com/azerupi/mdBook/releases). Make sure to put the path to the binary into your `PATH`.
Once you have installed Rust, type the following in the terminal: 2. **From Crates.io**
``` This requires [Rust and Cargo](https://www.rust-lang.org/) to be installed. Once you have installed Rust, type the following in the terminal:
cargo install mdbook ```
``` cargo install mdbook
```
This will download and compile mdBook for you, the only thing you that will be left to do is add the Cargo bin directory to your path. This will download and compile mdBook for you, the only thing left to do is to add the Cargo bin directory to your `PATH`.
##### Install from git 3. **From Git**
The version published to Crates.io will ever so slightly be behind the version hosted here on Github. If you need the latest version you can build the git version of mdBook yourself. Cargo makes this ***super easy***!
The version published to Crates.io will ever so slightly be behind the version hosted here on Github. If you need the latest version you can build the git version of mdBook yourself. Cargo makes this ***super easy***! ```
cargo install --git https://github.com/azerupi/mdBook.git
```
Again, make sure to add the Cargo bin directory to your `PATH`
First, clone the repository on your computer: 4. **For Contributions**
If you want to contribute to mdBook you will have to clone the repository on your local machine:
``` ```
git clone --depth 1 https://github.com/azerupi/mdBook.git git clone https://github.com/azerupi/mdBook.git
``` ```
`cd` into `mdBook/` and run
Then `cd` into the directory and run: ```
cargo build
```
``` the resulting binary can be found in `mdBook/target/debug/` under the name `mdBook` or `mdBook.exe`
cargo build --release
```
The executable will be in `./target/release/mdbook`.
@ -104,6 +110,8 @@ See the [Documentation](http://azerupi.github.io/mdBook/lib/lib.html) and the [A
Contributions are highly appreciated and encouraged! Don't hesitate to participate to discussions in the issues, propose new features and ask for help. Contributions are highly appreciated and encouraged! Don't hesitate to participate to discussions in the issues, propose new features and ask for help.
If you are not very confident with Rust, **I will be glad to mentor as best as I can if you decide to tackle an issue or new feature.**
People who are not familiar with the code can look at [issues that are tagged **easy**](https://github.com/azerupi/mdBook/labels/Easy). A lot of issues are also related to web development, so people that are not comfortable with Rust can also participate! :wink: People who are not familiar with the code can look at [issues that are tagged **easy**](https://github.com/azerupi/mdBook/labels/Easy). A lot of issues are also related to web development, so people that are not comfortable with Rust can also participate! :wink:
You can pick any issue you want to work on. Usually it's a good idea to ask if someone is already working on it and if not to claim the issue. You can pick any issue you want to work on. Usually it's a good idea to ask if someone is already working on it and if not to claim the issue.