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