Skip to content

Commit

Permalink
update to use npm scripts
Browse files Browse the repository at this point in the history
  • Loading branch information
jondavidjohn committed Sep 23, 2016
1 parent 34db1af commit 2185f07
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 7 deletions.
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Yay, you're interested in helping this thing suck less. Good for you!
Some things you should be familiar with before getting started

- Unit testing (with [QUnit](http://qunitjs.com))
- [Grunt](http://gruntjs.org) (available via `npm install -g grunt-cli`)
- [Grunt](http://gruntjs.org)
- [Node/NPM](https://npmjs.org/) (available via homebrew)

## Project Layout
Expand All @@ -17,15 +17,15 @@ Some things you should be familiar with before getting started

## Development

Once you have NPM and Grunt installed, clone the repository (with `--recursive` to also clone all submodules) and install all dependencies
Once you have npm installed, clone the repository (with `--recursive` to also clone all submodules) and install all dependencies

git clone git@.....hidpi-canvas-polyfill.git --recursive
cd hidpi-canvas-polyfill
npm install

Then to build a distribution run this grunt task
Then to build a distribution run

grunt dist
npm run build

This will generate the compiled (and minified) sourc in your `dist/` directory
along with a distributable zip archive.
Expand All @@ -35,7 +35,7 @@ need to re-run this command.

You can also use

grunt watch
npm run watch

to automatically reconcat the unminified file everytime you
change any of the `src/**/*.js` files.
Expand All @@ -49,7 +49,7 @@ sure to organize and produce tests that fit the patterns present.

### Running Tests

grunt test
npm test

## On Contribution

Expand Down
4 changes: 3 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@
},
"scripts": {
"test": "grunt",
"prepublish": "grunt dist"
"watch": "grunt watch",
"build": "grunt dist",
"prepublish": "npm run build"
}
}

0 comments on commit 2185f07

Please sign in to comment.