aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPhil Crosby2012-06-12 22:17:38 -0700
committerPhil Crosby2012-06-12 22:17:38 -0700
commit0828390b3d175c7a21701e3a4a5bc57c6dcc59be (patch)
treea78677f7332915d0588195719fb45822c9ab26a8
parentf69f952d9332dcc6e4831ec52982f0012d4aed9f (diff)
downloadvimium-0828390b3d175c7a21701e3a4a5bc57c6dcc59be.tar.bz2
Update the install instructions to include building from coffeescript
I've seen other projects just commit the compiled javascript, so users don't need to build it first. Feels messy to me, but I'm open to debate.
-rw-r--r--README.markdown12
1 files changed, 7 insertions, 5 deletions
diff --git a/README.markdown b/README.markdown
index 1bab6753..46d87e94 100644
--- a/README.markdown
+++ b/README.markdown
@@ -11,10 +11,12 @@ You can install the stable version of Vimium from the
Alternatively, you can install it from source:
-1. Navigate to `chrome://extensions`
-2. Toggle into Developer Mode
-3. Click on "Load Unpacked Extension..."
-4. Select the Vimium directory.
+1. Install [Coffeescript](http://coffeescript.org/#installation) (needed to build vimium).
+2. Run `cake build` in the Vimium directory.
+3. Navigate to `chrome://extensions`
+4. Toggle into Developer Mode
+5. Click on "Load Unpacked Extension..."
+6. Select the Vimium directory.
The Options page can be reached via a link on the help dialog (hit `?`) or via the button next to Vimium on
the Chrome Extensions page (`chrome://extensions`).
@@ -132,7 +134,7 @@ Vimium is written in Coffeescript, which compiles to Javascript. To build Vimium
When you're done, send us a pull request on Github. Feel free to include a change to the CREDITS file with
your patch.
-Some brief coding style guidelines: 1) follow the style already present in the file, 2) ensure your lines
+A few coding style guidelines: 1) follow the style already present in the file, 2) ensure your lines
don't exceed 110 characters.
Release Notes