minetest_modding_book/README.md

54 lines
1.2 KiB
Markdown
Raw Normal View History

2014-12-11 11:31:54 -08:00
Minetest Doc
2014-12-11 00:56:37 -08:00
============
2014-12-12 00:49:10 -08:00
This online book will teach you how to create mods in easy chapters.//
2014-12-11 11:38:46 -08:00
The chapters will explain a concept, give examples, and set tasks for you to complete.
2014-12-11 00:56:37 -08:00
2014-12-12 00:49:10 -08:00
This documentation was created by the Minetest community in order to//
2014-12-11 11:38:46 -08:00
help new modders gain a foothold.
2014-12-12 00:49:10 -08:00
You can contribute to this project on GitHub.//
2014-12-11 11:38:46 -08:00
It uses Jekyll to turn Markdown into a website.
2014-12-12 00:49:10 -08:00
Book written by rubenwardy and contributers.//
2014-12-11 11:38:46 -08:00
License: CC-BY-NC-SA 3.0
2014-12-12 00:49:10 -08:00
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/**
2014-12-11 00:56:37 -08:00
2014-12-11 11:31:54 -08:00
```
2014-12-11 11:38:46 -08:00
$ jekyll serve -b /minetest_doc
2014-12-11 11:31:54 -08:00
```
2014-12-11 11:38:46 -08:00
2014-12-12 00:49:10 -08:00
**Building to folder**
```
$ jekyll build
```
Goes to _site/
2014-12-11 11:38:46 -08:00
Commits
-------
If you are editing or creating a particular chapter, then use commit messages like this:
```
Getting Started - corrected typos
Entities - created chapter
```
Just use a normal style commit message otherwise.