Skip to content

Commit 9a59e34

Browse files
committed
added building and contributing to readme
1 parent 0a46cb2 commit 9a59e34

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,22 @@ Some of the demos are avaliable at [codepen.io/liabru](http://codepen.io/liabru/
103103
See the [Matter.js API Docs (v0.8.0)](http://brm.io/matter-js-docs/).
104104
<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/).
105105

106+
### Building and Contributing
107+
108+
To build you must first install [node.js](http://nodejs.org/) and [grunt](http://gruntjs.com/), then run
109+
110+
npm install
111+
112+
This will install the required build dependencies, then run
113+
114+
grunt dev
115+
116+
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.
117+
118+
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.
119+
120+
If you'd like to contribute but not sure what to work on, feel free to message me. Thanks!
121+
106122
### Changelog
107123

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

0 commit comments

Comments
 (0)