mirror of
https://github.com/Doodle3D/doodle3d-firmware.git
synced 2024-11-02 04:43:22 +01:00
97564de8fc
Add documentation in various places. |
||
---|---|---|
extra | ||
src | ||
.buildpath | ||
.gitignore | ||
.gitmodules | ||
.project | ||
Config.in | ||
config.ld | ||
doxify.sh | ||
Makefile | ||
post-install.sh | ||
post-remove.sh | ||
pre-remove.sh | ||
README.md | ||
TODO.md |
WiFi box OpenWRT firmware package
General documentation can be found on the wiki: http://doodle3d.com/wiki. Source code documentation can be generated, see below.
Documentation
The script 'doxify.sh' generates HTML documentation of the source code in the directory 'docs'. Make sure the 'ldoc' program is installed on your machine and the LDOC variable in the script points there.
On OSX, this can be accomplished by installing it through luarocks (run sudo luarocks install ldoc
). Luarocks can be installed using MacPorts. After installing that, the command would be sudo port install luarocks
.