vmario/doodle3d-firmware
0
0
Fork 0
mirror of https://github.com/Doodle3D/doodle3d-firmware.git synced 2024-12-22 02:53:49 +01:00
Code Issues Releases Wiki Activity
417 Commits 12 Branches 38 Tags 832 KiB
Lua 91.4%
Shell 5.5%
Makefile 2%
JavaScript 0.5%
HTML 0.4%
Other 0.1%
198a7024f9
Go to file
Olaf van der Kruk 198a7024f9 Update README.md 
Added small readme of the command line interface
2016-04-12 11:44:50 +02:00
.settings Merge branch 'develop' 2014-04-09 16:04:16 +02:00
extra Publish script comments update 2016-01-12 12:03:53 +01:00
src 0.10.9 version and release notes 2016-01-11 12:31:40 +01:00
test Integrate new release scripts with firmware. 2014-02-21 11:33:42 +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
.project Add openwrt diffconfig files (referenced from online wiki); change eclipse project name to match repository name. 2014-01-02 20:20:00 +01: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
license-spec.lua Add license + copyright info on external software. 2013-12-20 16:00:06 +01:00
LICENSE.txt Add license + copyright info on external software. 2013-12-20 16:00:06 +01:00
Makefile Include release notes as html in /www directory. 2013-12-12 14:08:22 +01:00
NOTICE.txt Update openwrt diffconfig to allow 802.11 driver to override regulatory domain stored in eeprom. 2014-02-01 01:41:39 +01:00
post-install.sh Fix uci-defaults script to exit with value 0. 2016-01-06 17:25:54 +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 Update README.md 2016-04-12 11:44:50 +02:00
ReleaseNotes.md 0.10.9 version and release notes 2016-01-11 12:31:40 +01:00

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. After installing that, the command would be sudo port install luarocks.

Command line interface

The Doodle3D API can be called using a terminal: d3dapi p=/network/scan r=GET Where the p parameter is the module you want to call and r is the method. Post request can be send using the same method: d3dapi p=/printer/print r=POST Parameters: TODO