Permalink
Browse files

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.
  • Loading branch information...
1 parent f69f952 commit 0828390b3d175c7a21701e3a4a5bc57c6dcc59be @philc committed Jun 13, 2012
Showing with 7 additions and 5 deletions.
  1. +7 −5 README.markdown
View
@@ -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

2 comments on commit 0828390

So that's why vimium stopped working in my browser!

Running cake build on my system (Ubuntu precise) didn't produce any .js file:

    $ cd src/vimium
    $ cake build
    $ find . -name '*.js'
    ./tests/shoulda.js

I installed coffeescript fresh from the tip of master at https://github.com/jashkenas/coffee-script.git

I've resorted to this for the time being:

$ find -name '*.coffee' -exec coffee -c {} \;
Owner

philc replied Jun 13, 2012

Oops, sorry @holygeek. cake autobuild is what I usually run and it worked. I broke cake build at some point. Fixed in c7a4dbb.

Please sign in to comment.