Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added npm build and doc scripts. Updated documentation. #149

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
------------------

Expand Down
18 changes: 2 additions & 16 deletions doc/development.md
Original file line number Diff line number Diff line change
@@ -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
4 changes: 4 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@
"src": "src",
"doc": "doc"
},
"scripts": {
"build": "grunt",
"doc": "grunt yuidoc"
},
"dependencies": {
"xhr2": "0.0.7",
"js-polyfills": "0.1.22",
Expand Down