[README] Mention ldoc documentation.
This commit is contained in:
parent
3e5b825b36
commit
11aacba7ed
13
README.md
13
README.md
|
@ -134,9 +134,18 @@ local yui = require 'lib.yui'
|
||||||
|
|
||||||
## Documentation
|
## 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.
|
straightforward and disciplined to have a decent overview of the functionality.
|
||||||
|
|
||||||
Examples are available at:
|
Examples are available at:
|
||||||
|
|
Loading…
Reference in New Issue