ExternalVendorCode/openmct
1
0
Fork 0
mirror of https://github.com/nasa/openmct.git synced 2025-06-21 00:23:01 +00:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

[Readme] Add notes on building documentation

Browse Source 
Add notes to README about building documentation; in
particular, document the need to install libcairo.
This commit is contained in:
Victor Woeltjen
2015-09-23 13:59:05 -07:00
parent f3aceb1644
commit e67a2e63cf
1 changed files with 12 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -103,6 +103,18 @@ This build will:
Run as `mvn clean install`. Run as `mvn clean install`.
### Building Documentation
Open MCT Web's documentation is generated by an
[npm](https://www.npmjs.com/)-based build:
* `npm install` _(only needs to run once)_
* `npm run docs`
Documentation will be generated in `target/docs`. Note that diagram
generation is dependent on having [Cairo](http://cairographics.org/download/)
installed.
# Glossary # Glossary
Certain terms are used throughout Open MCT Web with consistent meanings Certain terms are used throughout Open MCT Web with consistent meanings