Skip to content

Commit

Permalink
README: list dependencies and explain where to find API documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Dirk Feytons committed Oct 27, 2016
1 parent f51152b commit f4cc96f
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,28 @@
A collection of Lua modules with useful utility functions and bindings to C
functions and libraries.

The documentation in the code can be extracted with [LDoc](https://github.com/stevedonovan/ldoc).
Documentation of the API can be found on https://dirkfeytons.github.io/lua-tch/
It's generated with [LDoc](https://github.com/stevedonovan/ldoc). The config
used to generate the documentation can be found in `./doc/config.ld`.
Generating the documentation is as simple as `ldoc -c ./doc/config.ld src/`
from the root of the repository. The generated documentation can then be found
in `./doc`.

This code was originally developed in [Technicolor](http:https://www.technicolor.com/),
hence the `-tch` in the name.

## Dependencies

`lua-tch` uses or binds functionality from the following libraries:

- [Lua](http:https://www.lua.org)
- [OpenSSL](https://www.openssl.org/)
- [libubox](https://git.lede-project.org/?p=project/libubox.git)
- A netlink library such as libnl-tiny from [OpenWrt](https://github.com/openwrt/openwrt/tree/master/package/libs/libnl-tiny)/
[LEDE](https://git.lede-project.org/?p=source.git;a=tree;f=package/libs/libnl-tiny)
- [libuuid](https://www.kernel.org/pub/linux/utils/util-linux/)


## License

`lua-tch` uses the 2-clause ClearBSD license.
Expand Down

0 comments on commit f4cc96f

Please sign in to comment.