README.md

   1 Evented I/O for V8 javascript.
   2 ===
   3
   4 ### To build:
   5
   6 Prerequisites (Unix only):
   7
   8     * GCC 4.2 or newer
   9     * Python 2.6 or 2.7
  10     * GNU Make 3.81 or newer
  11     * libexecinfo (FreeBSD and OpenBSD only)
  12
  13 Unix/Macintosh:
  14
  15 ```sh
  16 ./configure
  17 make
  18 make install
  19 ```
  20
  21 With libicu i18n support:
  22
  23 ```sh
  24 svn checkout --force --revision 214189 \
  25    http://src.chromium.org/svn/trunk/deps/third_party/icu46 \
  26    deps/v8/third_party/icu46
  27 ./configure --with-icu-path=deps/v8/third_party/icu46/icu.gyp
  28 make
  29 make install
  30 ```
  31
  32 If your python binary is in a non-standard location or has a
  33 non-standard name, run the following instead:
  34
  35 ```sh
  36 export PYTHON=/path/to/python
  37 $PYTHON ./configure
  38 make
  39 make install
  40 ```
  41
  42 Prerequisites (Windows only):
  43
  44     * Python 2.6 or 2.7
  45     * Visual Studio 2010 or 2012
  46
  47 Windows:
  48
  49     vcbuild nosign
  50
  51 You can download pre-built binaries for various operating systems from
  52 [http://nodejs.org/download/](http://nodejs.org/download/).  The Windows
  53 and OS X installers will prompt you for the location to install to.
  54 The tarballs are self-contained; you can extract them to a local directory
  55 with:
  56
  57 ```sh
  58 tar xzf /path/to/node-<version>-<platform>-<arch>.tar.gz
  59 ```
  60
  61 Or system-wide with:
  62
  63 ```sh
  64 cd /usr/local && tar --strip-components 1 -xzf \
  65                     /path/to/node-<version>-<platform>-<arch>.tar.gz
  66 ```
  67
  68 ### To run the tests:
  69
  70 Unix/Macintosh:
  71
  72 ```sh
  73 make test
  74 ```
  75
  76 Windows:
  77
  78 ```sh
  79 vcbuild test
  80 ```
  81
  82 ### To build the documentation:
  83
  84 ```sh
  85 make doc
  86 ```
  87
  88 ### To read the documentation:
  89
  90 ```sh
  91 man doc/node.1
  92 ```
  93
  94 Resources for Newcomers
  95 ---
  96   - [The Wiki](https://github.com/joyent/node/wiki)
  97   - [nodejs.org](http://nodejs.org/)
  98   - [how to install node.js and npm (node package manager)](http://www.joyent.com/blog/installing-node-and-npm/)
  99   - [list of modules](https://github.com/joyent/node/wiki/modules)
 100   - [searching the npm registry](http://npmjs.org/)
 101   - [list of companies and projects using node](https://github.com/joyent/node/wiki/Projects,-Applications,-and-Companies-Using-Node)
 102   - [node.js mailing list](http://groups.google.com/group/nodejs)
 103   - irc chatroom, [#node.js on freenode.net](http://webchat.freenode.net?channels=node.js&uio=d4)
 104   - [community](https://github.com/joyent/node/wiki/Community)
 105   - [contributing](https://github.com/joyent/node/wiki/Contributing)
 106   - [big list of all the helpful wiki pages](https://github.com/joyent/node/wiki/_pages)