Skip to content

Commit 259ecfb

Browse files
committed
Update readme
1 parent 9a43f9f commit 259ecfb

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,22 +12,28 @@ To have an idea of what a rendered book looks like,take a look at the [**Documen
1212

1313
## Installation
1414

15-
Before building mdBook, make sure that you installed `stylus` and `nib` from `npm` because it is used to compile the stylesheets
15+
```
16+
git clone --depth=1 https://github.com/azerupi/mdBook.git
17+
cd mdBook
18+
cargo build --release
19+
```
20+
21+
The executable `mdbook` will be in the `./target/release` folder, this should be added to the path.
22+
23+
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
1624

1725
Install [node.js](https://nodejs.org/en/)
1826

1927
```
2028
npm install -g stylus nib
2129
```
2230

31+
Then build with the `regenerate-css` feature:
32+
2333
```
24-
git clone --depth=1 https://github.com/azerupi/mdBook.git
25-
cd mdBook
26-
cargo build --release
34+
cargo build --release --features="regenerate-css"
2735
```
2836

29-
The executable `mdbook` will be in the `./target/release` folder, this should be added to the path.
30-
3137
## Structure
3238

3339
There are two main parts of this project:

0 commit comments

Comments
 (0)