Skip to content
mzedeler edited this page Jun 8, 2012 · 18 revisions

What You Need

Besides git, you'll need:

  1. The node.js JavaScript runtime.
  2. The CoffeeScript compiler which also includes the cake utility.
  3. The Compass CSS framework (optional).
  4. The Docco documentation generator (optional).

Note that without Compass, you won't be able to compile SASS files to CSS, so some build tasks (i.e. cake app and cake sass) will fail. Without Docco, you won't be able to generate HTML docs, so cake docs will fail.

CoffeeScript & Docco

Mac OS X

If you use the pre-made Node.js installer, it should also install npm - the node.js package manager. You can then use npm to install CoffeeScript and Docco. Check their sites for installation instructions.

Windows

Well, not I don't know exactly, but this StackOverflow answer seems a good place to start. Don't know about Docco, though. Check also Building CoffeeScript with Sublime on Windows

Compass (optional)

For Compass, you'll need Ruby and RubyGems installed.

Mac OS X

On Mac OS X, both Ruby and RubyGems is preinstalled, so just follow the installation instructions on Compass' site

Windows

No idea. Have fun!


Installing Everything on Mac OS X

NOTE I'm writing this in the past, so check the sites for updates. This is just here for reference.

$ ... means that it's a Terminal command, i.e. type everything after the $ into the Terminal and hit the return key.

  1. Install Node.js using the installer from nodejs.org which should also install npm
  2. Install CoffeeScript: $ npm install --global coffee-script
  3. Install Compass: $ gem update --system && gem install compass
  4. Install Docco: $ sudo npm install docco (requires your password)

Installing Everything on debian

  1. Get nvm and use it to download, compile and install Node.js.

  2. Install npm:

curl http://npmjs.org/install.sh | sh

  1. Install coffeescript using npm:

npm install -g coffee-script

  1. Install docco:

apt-get install python-pygments

npm install -g docco

  1. Install compass using rubygems (gem install compass).
Clone this wiki locally