Skip to content

Commit

Permalink
added building and contributing to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
liabru committed May 10, 2014
1 parent 0a46cb2 commit 9a59e34
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,22 @@ Some of the demos are avaliable at [codepen.io/liabru](http://codepen.io/liabru/
See the [Matter.js API Docs (v0.8.0)](http://brm.io/matter-js-docs/).
<br>If you're using the [edge version (master)](https://raw2.github.com/liabru/matter-js/master/build/matter.js) then see the [API Docs (master)](http://brm.io/matter-js-docs-master/).

### Building and Contributing

To build you must first install [node.js](http://nodejs.org/) and [grunt](http://gruntjs.com/), then run

npm install

This will install the required build dependencies, then run

grunt dev

which is a task that builds the `matter-dev.js` file, spawns a `connect` and `watch` server, then opens `demo/dev.html` in your browser. Any changes you make to the source will automatically rebuild `matter-dev.js` and reload your browser for quick and easy testing.

Contributions are welcome, please ensure they follow the same style and architecture as the rest of the code. You should run `grunt test` to ensure `jshint` gives no errors. Please do not include any changes to the files in the `build` directory.

If you'd like to contribute but not sure what to work on, feel free to message me. Thanks!

### Changelog

To see what's new or changed in the latest version, see the [changelog](https://github.com/liabru/matter-js/blob/master/CHANGELOG.md)
Expand Down

0 comments on commit 9a59e34

Please sign in to comment.