www.aleph1.co.uk Git - yaffs-website/blob - node_modules/coffee-script/README.md

   1             {
   2          }   }   {
   3         {   {  }  }
   4          }   }{  {
   5         {  }{  }  }                    _____       __  __
   6        { }{ }{  { }                   / ____|     / _|/ _|
   7      .- { { }  { }} -.               | |     ___ | |_| |_ ___  ___
   8     (  { } { } { } }  )              | |    / _ \|  _|  _/ _ \/ _ \
   9     |`-..________ ..-'|              | |___| (_) | | | ||  __/  __/
  10     |                 |               \_____\___/|_| |_| \___|\___|
  11     |                 ;--.
  12     |                (__  \            _____           _       _
  13     |                 | )  )          / ____|         (_)     | |
  14     |                 |/  /          | (___   ___ _ __ _ _ __ | |_
  15     |                 (  /            \___ \ / __| '__| | '_ \| __|
  16     |                 |/              ____) | (__| |  | | |_) | |_
  17     |                 |              |_____/ \___|_|  |_| .__/ \__|
  18      `-.._________..-'                                  | |
  19                                                         |_|
  20
  21 CoffeeScript is a little language that compiles into JavaScript.
  22
  23 ## Installation
  24
  25 If you have the node package manager, npm, installed:
  26
  27 ```shell
  28 npm install -g coffee-script
  29 ```
  30
  31 Leave off the `-g` if you don't wish to install globally. If you don't wish to use npm:
  32
  33 ```shell
  34 git clone https://github.com/jashkenas/coffeescript.git
  35 sudo coffeescript/bin/cake install
  36 ```
  37
  38 ## Getting Started
  39
  40 Execute a script:
  41
  42 ```shell
  43 coffee /path/to/script.coffee
  44 ```
  45
  46 Compile a script:
  47
  48 ```shell
  49 coffee -c /path/to/script.coffee
  50 ```
  51
  52 For documentation, usage, and examples, see: http://coffeescript.org/
  53
  54 To suggest a feature or report a bug: http://github.com/jashkenas/coffeescript/issues
  55
  56 If you'd like to chat, drop by #coffeescript on Freenode IRC.
  57
  58 The source repository: https://github.com/jashkenas/coffeescript.git
  59
  60 Changelog: http://coffeescript.org/#changelog
  61
  62 Our lovely and talented contributors are listed here: http://github.com/jashkenas/coffeescript/contributors