1414codeforge
/
yui
mirror of https://codeberg.org/1414codeforge/yui.git
1
0
Fork 0
Code Packages Projects Releases Activity

[README] Mention ldoc documentation.

This commit is contained in:
Lorenzo Cogotti 2022-11-06 17:48:22 +01:00
parent 3e5b825b36
commit 11aacba7ed
1 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -134,9 +134,18 @@ local yui = require 'lib.yui'
## Documentation
...Ouch.
Code is documented with [LDoc](https://github.com/lunarmodules/LDoc).
Documentation is underway, however the source code is (IMHO) sufficiently
Documentation may be generated running the command:
```sh
ldoc .
```
`ldoc` generates a `doc` directory, open `doc/index.html`
with your favorite browser to read the documentation.
The source code is also (IMHO) sufficiently
straightforward and disciplined to have a decent overview of the functionality.
Examples are available at: