summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWuzzy <almikes@aol.com>2016-12-12 12:45:45 +0100
committerWuzzy <almikes@aol.com>2016-12-12 12:45:45 +0100
commitcb0296654e6add045459c597f270d60440bc3244 (patch)
tree54bd011b69a7a70542dd1ae3ee583b8baaf61117
parent8c4c6f2d1f3572fd27f62ea43c5dd402a2e2c675 (diff)
Rename modpack to “Help”
-rw-r--r--API.md2
-rw-r--r--README.md13
-rw-r--r--description.txt2
3 files changed, 9 insertions, 8 deletions
diff --git a/API.md b/API.md
index 7c8f23b..912821f 100644
--- a/API.md
+++ b/API.md
@@ -220,7 +220,7 @@ factoids for nodes.
Add a custom factoid (see above) for the specified category.
-* `category_id`: The documentation category for which the factoid applies:
+* `category_id`: The help category for which the factoid applies:
* `"nodes"`: Blocks
* `"tools"`: Tools and weapons
* `"craftitems"`: Misc. items
diff --git a/README.md b/README.md
index 530b314..0547a2e 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
-# Item Documentation [`doc_items`] (Version 0.8.0)
+# Item Help [`doc_items`] (Version 0.8.0)
## Description
-Automatically generated documentation of blocks, tools, weapons, crafting
+Automatically generated help texts of blocks, tools, weapons, crafting
items and other items.
The goal is to tell the player as much about basically almost all items as
@@ -13,9 +13,10 @@ This mod is useful to learn the hard facts about practically all items, like
how much damage weapon XYZ deals or whether you can dig that block.
This mod does *not* give you long explanations about how to use certain
nontrivial things, like the furnace from Minetest Game. This info might be
-provided by other mods and insert it into the documentation system.
+provided by other mods and insert it into the help.
-This mod provides 3 new categories for the Documentation System [`doc`]:
+This mod provides 3 new help categories (using the
+Documentation System [`doc`]):
* Blocks (e.g. dirt, stone, wooden stair)
* Tools and weapons (e.g. wooden pickaxe, steel sword, screwdriver)
@@ -36,7 +37,7 @@ This mod also allows for mods to adding custom written description
and usage help texts in free-form and even custom automatically generated texts
for mod-specific information like flammability in Minetest Game. This is
one of the core features of this mod; the mod relies on other mods to
-provide their custom help texts for a full documentation.
+provide their custom help texts for a complete help.
If you find a particular item which is lacking an explanation on usage,
request the mod author to add `doc_items` support. (But please wait
@@ -48,7 +49,7 @@ your custom factoids (single pieces of information extracted from the
item definition) and more.
For example, if your mods have some complex items which need
-explanation, this mod can help you in adding documentation for them.
+explanation, this mod can help you in adding help texts for them.
Read `API.md` to learn more.
diff --git a/description.txt b/description.txt
index c17b230..7291077 100644
--- a/description.txt
+++ b/description.txt
@@ -1 +1 @@
-Adds automatically generated help texts for items using the Documentation System mod.
+Adds automatically generated help texts for items.