ExternalVendorCode/openmct
1
0
Fork 0
mirror of https://github.com/nasa/openmct.git synced 2024-12-19 21:27:52 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

modified README.md for better documentation

Browse Source
This commit is contained in:
Sarin 2016-06-21 17:09:09 +07:00
parent 9cb26b73b5
commit bfc6ed4604
1 changed files with 15 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -22,21 +22,8 @@ instance (e.g. by starting an HTTP server in that directory), including:
Additional `gulp` tasks are defined in [the gulpfile](gulpfile.js).
### Building Documentation
Open MCT's documentation is generated by an
[npm](https://www.npmjs.com/)-based build. It has additional dependencies that
may not be available on every platform and thus is not covered in the standard
npm install. Ensure your system has [libcairo](http://cairographics.org/)
installed and then run the following commands:
* `npm install`
* `npm install canvas nomnoml`
* `npm run docs`
Documentation will be generated in `target/docs`.
### Building Open MCT
Once downloaded, Open MCT can be built with the following command:
npm install
@ -56,6 +43,20 @@ Once built, Open MCT can be run using the command:
For more information on building and running Open MCT, please see our getting started guide - https://nasa.github.io/openmct/getting-started/
### Building Documentation
Open MCT's documentation is generated by an
[npm](https://www.npmjs.com/)-based build. It has additional dependencies that
may not be available on every platform and thus is not covered in the standard
npm install. Ensure your system has [libcairo](http://cairographics.org/)
installed and then run the following commands:
* `npm install`
* `npm install canvas nomnoml`
* `npm run docs`
Documentation will be generated in `target/docs`.
## Bundles
A bundle is a group of software components (including source code, declared