From 7c936d5f464cf1f294b74529c94b482731d6e983 Mon Sep 17 00:00:00 2001 From: liabru Date: Sat, 10 May 2014 16:13:49 +0100 Subject: [PATCH] added CONTRIBUTING.md --- CONTRIBUTING.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..1bc8b85 --- /dev/null +++ b/CONTRIBUTING.md @@ -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. \ No newline at end of file