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