overte/tools/jsdoc/README.md
2016-11-10 09:33:56 -08:00

13 lines
278 B
Markdown

#JavaScript Documentation Generation
##Prerequisites
* Install node.js
* Install jsdoc via npm. `npm install jsdoc -g`
To generate html documentation for the High Fidelity JavaScript API
`cd scripts/jsdoc`
`jsdoc . -c config.json`
The out folder should contain index.html