mirror of https://github.com/Doodle3D/doodle3d-firmware.git synced 2024-12-22 02:53:49 +01:00

Go to file

Wouter R 97564de8fc Add LDoc configuration and slightly extend doxify.sh. Add documentation in various places.		2013-11-04 22:34:09 +01:00
extra	Changes to use external doodle3d-client package instead of submodule.	2013-10-22 18:32:53 +02:00
src	Add LDoc configuration and slightly extend doxify.sh.	2013-11-04 22:34:09 +01:00
.buildpath	Initial checkin of Doodle3D WiFi-box project. Files in src directory belong in /usr/share/lua/autowifi on the device and needs several symlinks as described in the readme.	2013-04-04 10:18:08 +02:00
.gitignore	Add doxify.sh to generate HTML code documentation using ldoc; update documentation in several utility files.	2013-07-29 12:07:23 +02:00
.gitmodules	Remove submodule gpx (can now be found in the print3d repository).	2013-10-28 21:06:31 +01:00
.project	Add package configuration options (not used yet)i; test code/scripts for postinstall/preremove; update TODO; add support for eclipse ShellEd plugin.	2013-05-03 13:11:58 +02:00
Config.in	Update Makefile and Config.in to handle/describe new www directory and API test interface properly.	2013-07-12 17:26:12 +02:00
config.ld	Add LDoc configuration and slightly extend doxify.sh.	2013-11-04 22:34:09 +01:00
doxify.sh	Add LDoc configuration and slightly extend doxify.sh.	2013-11-04 22:34:09 +01:00
Makefile	Add symlink to sketch directory in www directory.	2013-10-30 20:36:18 +01:00
post-install.sh	Add status request to sketch api.	2013-10-28 19:38:53 +01:00
post-remove.sh	Properly start and stop signin.sh on package installation and removal.	2013-10-22 22:44:51 +02:00
pre-remove.sh	Properly start and stop signin.sh on package installation and removal.	2013-10-22 22:44:51 +02:00
README.md	Add doxify.sh to generate HTML code documentation using ldoc; update documentation in several utility files.	2013-07-29 12:07:23 +02:00
TODO.md	Update TODO (beware, it's a mess)	2013-08-04 11:31:52 +02:00

README.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.