aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--CONTRIBUTING.md12
1 files changed, 11 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index e4ed8b8b..3423cc8e 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -26,13 +26,23 @@ Please include the following when reporting an issue:
Vimium is written in Coffeescript, which compiles to Javascript. To
install Vimium from source:
- 1. Install [Coffeescript](http://coffeescript.org/#installation).
+ 1. Install [Coffeescript v1](http://coffeescript.org/#installation) (`npm install --global coffeescript@~1`).
1. Run `cake build` from within your vimium directory. Any coffeescript files you change will now be automatically compiled to Javascript.
+
+### Chrome/Chromium
+
1. Navigate to `chrome://extensions`
1. Toggle into Developer Mode
1. Click on "Load Unpacked Extension..."
1. Select the Vimium directory.
+### Firefox
+
+ 1. Open Firefox
+ 1. Enter "about:debugging" in the URL bar
+ 1. Click "Load Temporary Add-on"
+ 1. Open the Vimium directory and select any file inside.
+
## Development tips
1. Run `cake autobuild` to watch for changes to coffee files, and have the .js files automatically