aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJez Ng2012-09-08 04:39:46 -0400
committerJez Ng2012-09-08 04:39:46 -0400
commit88da24bf5a531d546b84d9f349e2bf4f62da23be (patch)
tree4d6072153d32fc33ad75b1826ed1873e4d789900
parent6df16c591219d87058b4c48682d503382e44693f (diff)
downloadvimium-88da24bf5a531d546b84d9f349e2bf4f62da23be.tar.bz2
Update README with testing instructions.
-rw-r--r--README.markdown6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.markdown b/README.markdown
index 4e42c062..c0d99e27 100644
--- a/README.markdown
+++ b/README.markdown
@@ -138,6 +138,12 @@ Vimium is written in Coffeescript, which compiles to Javascript. To build Vimium
1. Install [Coffeescript](http://coffeescript.org/#installation).
2. Run `cake autobuild` from within your vimium directory. Any coffeescript files you change will now be automatically compiled to Javascript.
+
+Our tests use [shoulda.js](https://github.com/philc/shoulda.js) and [PhantomJS](http://phantomjs.org/). To run
+the tests:
+
+1. `git submodule update --init --recursive` -- this pulls in shoulda.js.
+2. [Install PhantomJS.](http://phantomjs.org/download.html)
3. `cake test` to run the tests.
When you're done, send us a pull request on Github. Feel free to include a change to the CREDITS file with