This project contains all Mudlet lua code (lua folder).
This will allow us to easily maintain it and generate common documentation with LuaDoc.
(We are using improved version of LuaDoc, because LuaDoc 3.0.1 is barely usable.)
You can generate doc on linux box with following command (mudlet-lua-doc folder).
You will need LuaDoc 3.0.1 (with custom improvements, which are in lua/luadoc folder)
sh genDoc.sh
Project structure:
------------------
mudlet-lua/
lua/ all Lua code
luadoc/ LuaDoc extensions (this code is not loaded by Mudlet)
LuaGlobal.lua loader for all Lua code used by Mudlet
mudlet-lua-doc/ all generated documentation
CONTRIBS
genDoc.sh script for generation documentation
luadoc-guide.txt guide with basic LuaDoc conventions
README
TODO