From ff2886f72a4bab025d83ddee95eb7c32d15229e5 Mon Sep 17 00:00:00 2001 From: rubenwardy Date: Fri, 12 Dec 2014 08:49:10 +0000 Subject: [PATCH] Add building notes to README.md --- README.md | 32 ++++++++++++++++++++++++++------ 1 file changed, 26 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index faf43e4..e032a9e 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,45 @@ Minetest Doc ============ -This online book will teach you how to create mods in easy chapters.\\ +This online book will teach you how to create mods in easy chapters.// The chapters will explain a concept, give examples, and set tasks for you to complete. -This documentation was created by the Minetest community in order to\\ +This documentation was created by the Minetest community in order to// help new modders gain a foothold. -You can contribute to this project on GitHub.\\ +You can contribute to this project on GitHub.// It uses Jekyll to turn Markdown into a website. -Book written by rubenwardy and contributers.\\ +Book written by rubenwardy and contributers.// License: CC-BY-NC-SA 3.0 -Running -------- +Contributing +------------ + +You don't need to run jekyll, you can just edit and create files in// +chapters/. In fact, you don't even need to do markdown, send me a word document// +and I can convert it into the correct formatting. It is the writing which is the hard// +bit, not the formatting. + +Running as a Website +-------------------- + +You can build it as a website using jekyll. + +**Serving on http://localhost:4000/** ``` $ jekyll serve -b /minetest_doc ``` +**Building to folder** + +``` +$ jekyll build +``` + +Goes to _site/ + Commits -------