Merge pull request #6 from christopheradams/readme-fix

Readme fixes for compiling and example request
This commit is contained in:
James Allen 2014-02-26 15:28:46 +00:00
commit 841d1cb872

View file

@ -18,7 +18,7 @@ Then install the require npm modules:
Then compile the coffee script source files: Then compile the coffee script source files:
$ grunt compile $ grunt install
Finally, (after configuring your local database - see the Config section), run the CLSI service: Finally, (after configuring your local database - see the Config section), run the CLSI service:
@ -40,14 +40,14 @@ The CLSI is based on a JSON API.
(Note that valid JSON should not contain any comments like the example below). (Note that valid JSON should not contain any comments like the example below).
POST /project/<project-id> POST /project/<project-id>/compile
```javascript ```javascript
{ {
compile: { "compile": {
"options": { "options": {
// Which compiler to use. Can be latex, pdflatex, xelatex or lualatex // Which compiler to use. Can be latex, pdflatex, xelatex or lualatex
"compiler": "lualatex" "compiler": "lualatex",
// How many seconds to wait before killing the process. Default is 60. // How many seconds to wait before killing the process. Default is 60.
"timeout": 40 "timeout": 40
}, },