diff options
| -rw-r--r-- | README.md | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..339a84f --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# Documentation System +This mod provides a simple and highly extensible formspec 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. + +Current version: 0.2.0 + +## For users +To open the help, say “/help” in chat. Everything else should be more or less +self-explanationary. + +This mod is useless on its own, you will only need this mod as a dependency +for mods which actually add some help entries. + +## For modders and subgame authors +This mod helps you in writing extensive documentation 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. |