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

[README] Add documentation walkthrough.

This commit is contained in:
Lorenzo Cogotti 2022-12-14 12:41:04 +01:00
parent 47768e58c5
commit 618c775cf5
1 changed files with 15 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -98,7 +98,7 @@ These may be picked with the `CONFIG` variable.
### Installing using Makefiles
**lua-osx** Makefile supports your average `clean`, `install` and `uninstall`
**lua-osx** Makefile supports your average `clean`, `doc`, `install` and `uninstall`
targets, thus you can install **lua-osx** system wide by running:
```sh
# make install
@ -106,7 +106,20 @@ targets, thus you can install **lua-osx** system wide by running:
## Documentation
Currently in progress, stay tuned!
**lua-osx** uses [LDoc]() for documentation.
You can generate documentation using `ldoc` directly, with the following command:
```sh
ldoc .
```
Or using the `doc` `Makefile` target:
```sh
make doc
```
Both methods generate a `doc` directory, open `doc/index.html`
with your favorite browser to read the API documentation.
## Similar Projects