From 541f990ae55e42b94453bcf0efe6718b588139b6 Mon Sep 17 00:00:00 2001 From: waynenilsen Date: Wed, 12 Aug 2015 09:04:00 -0400 Subject: [PATCH] added installation information 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. --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 40be9d0b..699da894 100644 --- a/README.md +++ b/README.md @@ -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: