diff --git a/README.md b/README.md index 42cd060282..8b982a8bb0 100644 --- a/README.md +++ b/README.md @@ -103,6 +103,18 @@ This build will: 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 Certain terms are used throughout Open MCT Web with consistent meanings