Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Trim the installation and usage sections; can backport to v1
- Loading branch information
1 parent
b398c88
commit cd8be89
Showing
2 changed files
with
3 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,27 +1,15 @@ | ||
## Installation | ||
|
||
The CoffeeScript compiler is itself [written in CoffeeScript](v<%= majorVersion %>/annotated-source/grammar.html), using the [Jison parser generator](http://jison.org). The command-line version of `coffee` is available as a [Node.js](http://nodejs.org/) utility. The [core compiler](v<%= majorVersion %>/browser-compiler/coffee-script.js) however, does not depend on Node, and can be run in any JavaScript environment, or in the browser (see “Try CoffeeScript”, above). | ||
The command-line version of `coffee` is available as a [Node.js](http://nodejs.org/) utility. The [core compiler](v<%= majorVersion %>/browser-compiler/coffee-script.js) however, does not depend on Node, and can be run in any JavaScript environment, or in the browser (see [Try CoffeeScript](#try)). | ||
|
||
To install, first make sure you have a working copy of the latest stable version of [Node.js](http://nodejs.org/). You can then install CoffeeScript globally with [npm](http://npmjs.org): | ||
|
||
> ``` | ||
npm install -g coffee-script | ||
npm install --global coffee-script | ||
``` | ||
When you need CoffeeScript as a dependency, install it locally: | ||
When you need CoffeeScript as a dependency of a project, within that project’s folder you can install it locally: | ||
|
||
> ``` | ||
npm install --save coffee-script | ||
``` | ||
If you’d prefer to install the latest **master** version of CoffeeScript, you can clone the CoffeeScript [source repository](http://github.com/jashkenas/coffeescript) from GitHub, or download [the source](http://github.com/jashkenas/coffeescript/tarball/master) directly. To install the latest master CoffeeScript compiler with npm: | ||
|
||
> ``` | ||
npm install -g jashkenas/coffeescript | ||
``` | ||
Or, if you want to install to `/usr/local`, and don’t want to use npm to manage it, open the `coffee-script` directory and run: | ||
|
||
> ``` | ||
sudo bin/cake install | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters