README.md

   1 # Documentation System
   2 This mod provides a simple and highly extensible formspec in which the user
   3 can access help pages about various things and the modder can add those pages.
   4 The mod itself does not provide any help texts, just the framework.
   5
   6 Current version: 0.2.0
   7
   8 ## For users
   9 To open the help, say “/help” in chat. Everything else should be more or less
  10 self-explanationary.
  11
  12 This mod is useless on its own, you will only need this mod as a dependency
  13 for mods which actually add some help entries.
  14
  15 ## For modders and subgame authors
  16 This mod helps you in writing extensive documentation for your mod or subgame.
  17 You can write about basically anything in the presentation you prefer.
  18
  19 To get started, read `API.md` in the directory of this mod.