microexpansion/doc/README.md
octacian 69771ca5fc "Modulize"
Allows modules to be added to the mod for easier development and management. See doc/modules.md.
2017-02-14 19:35:06 -08:00

5 lines
569 B
Markdown

# Documentation
The APIs provided by MicroExpansion are divided among several different files. Unless otherwise mentioned, the `.md` documentation file is labeled the same as the Lua file containing the code. However, for modules, documentation is found in a subdirectory. Below, the main documentation sections are found before being divided depending on the module.
### `modules.md`
Non-API portions of MicroExpansion are loaded as modules to allow them to be easily enabled or disabled. This documents the API for loading, configuring, and interacting with modules.