Goyslop/4chan-x
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update instructions for contributors.

Browse Source 
Remind contributors to pull in dependencies
using npm and to compile with make, not grunt.
This commit is contained in:
Koushien 2016-10-14 19:35:41 -07:00
parent dc0c0fb055
commit 92123bfa3b
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
CONTRIBUTING.md
View File

@ -29,7 +29,8 @@ If you're reporting a bug, the more detail you can give, the better. If I can't
- 4chan X is mostly written in [CoffeeScript](http://coffeescript.org/). If you're already familiar with Javascript, it doesn't take long to pick up.
- Edit the sources in the src/ directory (not the compiled scripts in builds/).
- Compile the script with: `grunt`
- Install dependencies with: `npm install`
- Compile the script with: `make`
- Install the compiled script (found in the testbuilds/ directory), and test your changes.
- Make sure you have set your name and email as you want them, as they will be published in your commit message:<br>`git config user.name yourname`<br>`git config user.email youremail`
- Commit your changes: `git commit -a`