From 259ecfb178abeb8d3094eafe6fc58778c0ea67ef Mon Sep 17 00:00:00 2001 From: Mathieu David Date: Thu, 24 Sep 2015 21:04:01 +0200 Subject: [PATCH] Update readme --- README.md | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 36f5af29..67963d95 100644 --- a/README.md +++ b/README.md @@ -12,14 +12,6 @@ To have an idea of what a rendered book looks like,take a look at the [**Documen ## 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 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. +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 There are two main parts of this project: