diff --git a/README.md b/README.md index 4b25ac5520..90a55b2a61 100644 --- a/README.md +++ b/README.md @@ -99,17 +99,16 @@ Run as `mvn clean install`. ### Building Documentation Open MCT Web's documentation is generated by an -[npm](https://www.npmjs.com/)-based build: +[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` _(only needs to run once)_ +* `npm install` +* `npm install nomnoml` * `npm run docs` -Documentation will be generated in `target/docs`. Note that diagram -generation is dependent on having [Cairo](http://cairographics.org/download/) -installed; see -[node-canvas](https://github.com/Automattic/node-canvas#installation)'s -documentation for help with installation. - +Documentation will be generated in `target/docs`. # Glossary diff --git a/circle.yml b/circle.yml index f1040a898c..36f4abf604 100644 --- a/circle.yml +++ b/circle.yml @@ -2,6 +2,7 @@ deployment: production: branch: master commands: + - npm install nomnoml - ./build-docs.sh - git push git@heroku.com:openmctweb-demo.git $CIRCLE_SHA1:refs/heads/master openmctweb-staging-un: diff --git a/package.json b/package.json index 753dd6b927..d325fe5bbe 100644 --- a/package.json +++ b/package.json @@ -7,7 +7,6 @@ "minimist": "^1.1.1" }, "devDependencies": { - "canvas": "^1.2.7", "glob": ">= 3.0.0", "jasmine-core": "^2.3.0", "jsdoc": "^3.3.2", @@ -24,7 +23,6 @@ "markdown-toc": "^0.11.7", "marked": "^0.3.5", "mkdirp": "^0.5.1", - "nomnoml": "^0.0.3", "requirejs": "^2.1.17", "split": "^1.0.0" },