From 87352ec86f2a01b905e88d86403eb3f60830312f Mon Sep 17 00:00:00 2001 From: garajo Date: Mon, 12 Feb 2018 20:57:00 -0800 Subject: [PATCH] Added npm build and doc scripts. Updated documentation. --- README.md | 10 ++++++++++ doc/development.md | 18 ++---------------- package.json | 4 ++++ 3 files changed, 16 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 004fa59..fa479eb 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,16 @@ Implementing a new Environment should be straightforward and requires overloadin of methods in the library. There are currently two examples, `Environment/Browser` and `Environment/Node`. +Build instructions +------------------ + +With Node.js installed and the requisite modules present, issue: + + npm run build + +This will generate build/tincan.js and build/tincan-min.js files. + + Attachment Support ------------------ diff --git a/doc/development.md b/doc/development.md index f085736..f18d878 100644 --- a/doc/development.md +++ b/doc/development.md @@ -1,22 +1,8 @@ -Development Processes -===================== - -Build instructions ------------------- - -For first time builds install Node.js with npm and then run `npm install gear gear-lib`. - -With Node.js installed and the requisite modules present, issue: - - ./build.js - -This will generate build/tincan.js and build/tincan-min.js files. - API Documentation Generation ---------------------------- -Install yuidoc via `npm install -g yuidocjs` and then from the base directory issue: +From the base directory issue: - yuidoc src/ + npm run doc Files will be output to doc/api/ which can be viewed by pointing a browser at the index.html at that path diff --git a/package.json b/package.json index d94b111..9499f08 100644 --- a/package.json +++ b/package.json @@ -9,6 +9,10 @@ "src": "src", "doc": "doc" }, + "scripts": { + "build": "grunt", + "doc": "grunt yuidoc" + }, "dependencies": { "xhr2": "0.0.7", "js-polyfills": "0.1.22",