MTSR/minetest_modding_book
4
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Add building notes to README.md

Browse Source
This commit is contained in:
rubenwardy 2014-12-12 08:49:10 +00:00
parent 8a0cc45550
commit ff2886f72a
1 changed files with 26 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -1,25 +1,45 @@
Minetest Doc 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. 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. 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. 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 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 $ jekyll serve -b /minetest_doc
``` ```
**Building to folder**
```
$ jekyll build
```
Goes to _site/
Commits Commits
------- -------