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