foster/liabru-matter-js
0
0
Fork 0
mirror of https://github.com/liabru/matter-js.git synced 2024-12-26 13:49:01 -05:00
Code Issues Wiki Activity

added CONTRIBUTING.md

Browse source
This commit is contained in:
liabru 2014-05-10 16:13:49 +01:00
parent 9a59e34d8c
commit 7c936d5f46
1 changed files with 13 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,13 @@
### 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.