Permalink
Browse files

Update CONTRIBUTING.md

add developing information
  • Loading branch information...
1 parent aab2be6 commit 40cfe5adf2b9d2d077d954aa33ece70c71614831 @lukeapage lukeapage committed Dec 21, 2012
Showing with 29 additions and 0 deletions.
  1. +29 −0 CONTRIBUTING.md
View
29 CONTRIBUTING.md
@@ -19,3 +19,32 @@ Thankyou! Please take the time to read these guidelines
- tests - please add tests for your work. use `make test` to see if they pass
- spaces not tabs
- end lines in semi-colons - loosely aim towards jslint standards
+
+## Developing
+
+1. install cygwin - http://cygwin.com/install.html
+ - default options +
+ - Devel -> Make
+ -> Git
+2. install node.js - http://nodejs.org/
+3. install phantomJS - http://phantomjs.org/download.html
+ - copy to a directory of your choice
+ - (windows) modify the path directory to include whereever you have copied it
+4. clone the repository and download to local computer
+5. run `npm install -g diff` to get diffs in your tests
+
+`lessc or node bin/lessc`
+
+to run the less compiler
+
+`make test`
+
+runs the node tests
+
+`make browser-test`
+
+runs the headless browser tests
+
+`make browser-test-server`
+
+sets up the server for the headless tests.. then go to http://localhost:8081/browser/test-runner-main.htm or one of the other test runner pages created in /test/browser/

0 comments on commit 40cfe5a

Please sign in to comment.