aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJez Ng2012-09-09 15:34:29 -0400
committerJez Ng2012-09-09 15:38:36 -0400
commit8c2a65dfdf9c3b4e69bca15eb7705280758245c2 (patch)
tree88e36ed36a4deab7714d0228039d9e3f4a865153
parent7c870b5faee077dd6ae73da1ee637d26ba9f09c7 (diff)
downloadvimium-8c2a65dfdf9c3b4e69bca15eb7705280758245c2.tar.bz2
Tweak README.
-rw-r--r--README.markdown16
1 files changed, 10 insertions, 6 deletions
diff --git a/README.markdown b/README.markdown
index ceb741de..6861815e 100644
--- a/README.markdown
+++ b/README.markdown
@@ -146,13 +146,17 @@ the tests:
2. [Install PhantomJS.](http://phantomjs.org/download.html)
3. `cake test` to run the tests.
-Coverage reporting uses [JSCoverage](http://siliconforks.com/jscoverage/) and requires
-[node-temp](https://github.com/bruce/node-temp). `cake coverage` will generate a coverage report in the form
-of a JSON blob, which can then be viewed using [jscoverage-report](https://github.com/int3/jscoverage-report).
-See jscoverage-report's README for more details.
+Bugs and features are not the only way to contribute -- more tests are always welcome. You can find out which
+portions of code need them by looking at our coverage reports. To generate these reports:
-When you're done, send us a pull request on Github. Feel free to include a change to the CREDITS file with
-your patch.
+1. Download [JSCoverage](http://siliconforks.com/jscoverage/download.html) or `brew install jscoverage`
+2. `npm install temp`
+3. `cake coverage` will generate a coverage report in the form of a JSON file (`jscoverage.json`), which can
+ then be viewed using [jscoverage-report](https://github.com/int3/jscoverage-report). See
+ jscoverage-report's [README](https://github.com/int3/jscoverage-report#jscoverage-report) for more details.
+
+When you're done with your changes, send us a pull request on Github. Feel free to include a change to the
+CREDITS file with your patch.
A few coding style guidelines: 1) follow the style already present in the file, 2) ensure your lines
don't exceed 110 characters.