diff --git a/README.md b/README.md index 0c8cd0c..04f010a 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,24 @@ 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 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// +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 @@ -26,7 +26,7 @@ Running as a Website You can build it as a website using jekyll. -**Serving on http://localhost:4000/** +**Serving on http://localhost:4000/minetest_doc/** ``` $ jekyll serve -b /minetest_doc @@ -55,9 +55,9 @@ Just use a normal style commit message otherwise. HTML and CSS ------------ -The HTML is in _includes/.// -header.html contains all the HTML code above a chapter's content,// -footer.html contains all the HTML code below a chapter's content.// +The HTML is in _includes/. +header.html contains all the HTML code above a chapter's content, +footer.html contains all the HTML code below a chapter's content. The CSS is in static/ Example Chapter