vmario/doodle3d-firmware
0
0
Fork 0
mirror of https://github.com/Doodle3D/doodle3d-firmware.git synced 2024-12-22 11:03:48 +01:00
Code Issues Releases Wiki Activity

Update README.md

Browse Source 
Added small readme of the command line interface
This commit is contained in:
Olaf van der Kruk 2016-04-12 11:44:50 +02:00
parent e384ac4782
commit 198a7024f9
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -10,3 +10,13 @@ The script 'doxify.sh' generates HTML documentation of the source code in the di
Make sure the 'ldoc' program is installed on your machine and the LDOC variable in the script points there. 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`. 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`.
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