Mirrors/mdBook
2
0
Fork 0
mirror of https://github.com/rust-lang/mdBook synced 2024-12-13 14:22:35 +00:00
Code Issues Projects Releases Packages Wiki Activity

added installation information

Browse source 
You may want to move around where it goes I guess. I'm just thinking it might be nice to have at least this much information in there.
This commit is contained in:
waynenilsen 2015-08-12 09:04:00 -04:00
parent 0932bfd576
commit 541f990ae5
1 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -10,6 +10,16 @@ For more information about what is left on my to-do list, check the issue tracke
To have an idea of what a rendered book looks like,take a look at the [**Documentation**](http://azerupi.github.io/mdBook/). It is rendered by the latest version of mdBook.
## Installation
```
git clone --depth=1 https://github.com/azerupi/mdBook.git
cd mdBook
cargo build --release
```
The executable `mdbook` will be in the `./target/release` folder, this should be added to the path.
## Structure
There are two main parts of this project: