kotovalexarian-likes-github/jashkenas--coffeescript
1
0
Fork 0
mirror of https://github.com/jashkenas/coffeescript.git synced 2022-11-09 12:23:24 -05:00
Code Releases Activity

Trim the installation and usage sections; can backport to v1

Browse source
This commit is contained in:
Geoffrey Booth 2016-12-19 22:06:38 -08:00
parent b398c8809a
commit cd8be896c4
2 changed files with 3 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
documentation/sections/installation.md
View file

@ -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
```

8
documentation/sections/usage.md
View file

@ -48,14 +48,6 @@ Once installed, you should have access to the `coffee` command, which can execut
<tr>
<td>`-j, --join [FILE]`</td>
<td>Before compiling, concatenate all scripts together in the order they were passed, and write them into the specified file. (Deprecated.)</td>
</tr>
<tr>
<td>`-w, --watch`</td>
<td>Watch files for changes, rerunning the specified command when any file is updated.</td>