doodle3d-firmware/README.md

WiFi box OpenWRT firmware package
=================================

General documentation can be found on the wiki: <http://doodle3d.com/help/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](http://www.macports.org/). After installing that, the command would be `sudo port install luarocks`.
Add doxify.sh to generate HTML code documentation using ldoc; update documentation in several utility files. 2013-07-28 05:01:58 +02:00			`WiFi box OpenWRT firmware package`
			`=================================`

Update README.md 2013-11-29 12:00:49 +01:00			`General documentation can be found on the wiki: <http://doodle3d.com/help/wiki>. Source code documentation can be generated, see below.`
Add doxify.sh to generate HTML code documentation using ldoc; update documentation in several utility files. 2013-07-28 05:01:58 +02:00
			`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](http://www.macports.org/). After installing that, the command would be `sudo port install luarocks`.