Wuzzy/minetest_doc_example
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add short README

Browse Source
This commit is contained in:
Wuzzy 2016-12-19 14:17:22 +01:00
parent 2f62e53dd8
commit d5d4dc2897
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md Normal file
View File

@ -0,0 +1,19 @@
# Example mod for Help modpack (`doc`, `doc_items`, etc.)
This mod is for modders and useless for anyone else.
It demonstrates the usage of the APIs of the Help mods. This should help you in getting
started with this modpack.
Using the APIs of the Help modpack helps to improve the overall quality and completeness
of the entire help.
It includes examples for the following mods:
* `doc`: In `doc.lua`
* `doc_items`: In `doc_items.lua`
Activate this mod in your world to see some example categories, entries and items added.
Read the source code for some brief explanation.
THIS IS NOT A FULL EXAMPLE. Please read `API.md` of the respective mods to learn how to
use the mod properly.