Update README

This commit is contained in:
Wuzzy 2016-12-03 17:45:43 +01:00
parent 20e06d0cf5
commit 3ff68c33e5
1 changed files with 10 additions and 4 deletions

View File

@ -1,11 +1,17 @@
# Documentation System
* Version: 0.8.0
The goal of this modpack is to make using Minetest and mods easier for both newcomers and advanced users.
It makes it easier for newcomers by making help more accessible.
It makes life easier for advanced user by making it more convenient to use, by centralizing the help where you most need it: Inside the game.
This modpack will also make modder's life easier by allowing them to add help texts directly into mods (via `doc_items`).
More information is given in the respective mods.
There's no version number for the modpack; instead, the mods are versioned seperately.
Overview of the mods:
* `doc`: Core Documentation System API and user interface
* `doc_items`: Item Documentation. Adds automatically generated help texts for items and an API
* `doc_identifier`: Lookup Tool. A tool to identify and show help texts for pointed things
* `doc_encyclopedia`: Encyclopedia. An item to access the documentation system
* `doc_basics`: Basic help. Adds basic help texts about Minetest, controls, gameplay and other basics
* `doc_items`: Item Documentation. Adds automatically generated help texts for items and an API
* `doc_encyclopedia`: Encyclopedia. An item to access the documentation system
* `doc_identifier`: Lookup Tool. A tool to identify and show help texts for pointed things