From b382a6374e86ac66381e077ded171e12e7a93654 Mon Sep 17 00:00:00 2001 From: Sean Lilley Date: Fri, 6 Jan 2017 11:36:44 -0500 Subject: [PATCH] Updated README and LICENSE --- LICENSE.md | 26 ++++++++++++++++++++++++++ README.md | 39 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 65 insertions(+) diff --git a/LICENSE.md b/LICENSE.md index 8938747..abfee94 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -35,6 +35,32 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +### bluebird + +https://www.npmjs.com/package/bluebird + +> The MIT License (MIT) +> +> Copyright (c) 2013-2015 Petka Antonov +> +> Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: +> +> The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. +> +> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. + ### byline https://www.npmjs.com/package/byline diff --git a/README.md b/README.md index f1e7784..4469ba5 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,45 @@ Using obj2gltf as a command-line tool: |`--ao`|Apply ambient occlusion to the converted model.|No, default `false`| |`-h`|Display help|No| +## Build Instructions + +Run the tests: +``` +npm run test +``` +To run JSHint on the entire codebase, run: +``` +npm run jsHint +``` +To run JSHint automatically when a file is saved, run the following and leave it open in a console window: +``` +npm run jsHint-watch +``` + +### Running Test Coverage + +Coverage uses [istanbul](https://github.com/gotwarlost/istanbul). Run: +``` +npm run coverage +``` +For complete coverage details, open `coverage/lcov-report/index.html`. + +The tests and coverage covers the Node.js module; it does not cover the command-line interface, which is tiny. + +## Generating Documentation + +To generate the documentation: +``` +npm run jsdoc +``` + +The documentation will be placed in the `doc` folder. + +### Debugging + +* To debug the tests in Webstorm, open the Gulp tab, right click the `test` task, and click `Debug 'test'`. +* To run a single test, change the test function from `it` to `fit`. + ## Contributions Pull requests are appreciated. Please use the same [Contributor License Agreement (CLA)](https://github.com/AnalyticalGraphicsInc/cesium/blob/master/CONTRIBUTING.md) used for [Cesium](http://cesiumjs.org/).