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

Update readme

This commit is contained in:
Mathieu David 2015-09-24 21:04:01 +02:00
parent 9a43f9ff8c
commit 259ecfb178
1 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -12,14 +12,6 @@ To have an idea of what a rendered book looks like,take a look at the [**Documen
## Installation ## Installation
Before building mdBook, make sure that you installed `stylus` and `nib` from `npm` because it is used to compile the stylesheets
Install [node.js](https://nodejs.org/en/)
```
npm install -g stylus nib
```
``` ```
git clone --depth=1 https://github.com/azerupi/mdBook.git git clone --depth=1 https://github.com/azerupi/mdBook.git
cd mdBook cd mdBook
@ -28,6 +20,20 @@ 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.
If you want to regenerate the css (stylesheet), make sure that you installed `stylus` and `nib` from `npm` because it is used to compile the stylesheets
Install [node.js](https://nodejs.org/en/)
```
npm install -g stylus nib
```
Then build with the `regenerate-css` feature:
```
cargo build --release --features="regenerate-css"
```
## Structure ## Structure
There are two main parts of this project: There are two main parts of this project: