summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorWuzzy <almikes@aol.com>2016-12-12 12:42:18 +0100
committerWuzzy <almikes@aol.com>2016-12-12 12:42:18 +0100
commit26cc48a1b2ceece8759c9c7af03d23dff16b2648 (patch)
tree216ff8679969902142a780b0c4927e0fb40a6ad8 /README.md
parent8b268b179732abd7e077e3bc578e855cbb8256d8 (diff)
Rename modpack to “Help”
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 4 insertions, 3 deletions
diff --git a/README.md b/README.md
index b30b7cf..78b949c 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,8 @@
-# Documentation System
+# Documentation System [`doc`]
This mod provides a simple and highly extensible form in which the user
can access help pages about various things and the modder can add those pages.
The mod itself does not provide any help texts, just the framework.
+It is the heart of the Help modpack, on which the other Help mods depend.
Current version: 0.10.0
@@ -13,7 +14,7 @@ To open the help, there are multiple ways:
- If you use Unified Inventory or Minetest Game, you will find an extra
button in the inventory
-The documentation system itself should be more or less self-explanatory.
+The help itself should be more or less self-explanatory.
This mod is useless on its own, you will only need this mod as a dependency
for mods which actually add some help entries.
@@ -29,7 +30,7 @@ Players with the `doc_reveal` privilege can use the `/doc_reveal` chat command
to reveal all hidden entries instantly.
## For modders and subgame authors
-This mod helps you in writing extensive documentation for your mod or subgame.
+This mod helps you in writing extensive help for your mod or subgame.
You can write about basically anything in the presentation you prefer.
To get started, read `API.md` in the directory of this mod.