README.md

   1 Evented I/O for V8 javascript. [![Build Status](https://secure.travis-ci.org/joyent/node.png)](http://travis-ci.org/joyent/node)
   2 ===
   3
   4 ### To build:
   5
   6 Prerequisites (Unix only):
   7
   8     * Python 2.6 or 2.7
   9     * GNU Make 3.81 or newer
  10     * libexecinfo (FreeBSD and OpenBSD only)
  11
  12 Unix/Macintosh:
  13
  14     ./configure
  15     make
  16     make install
  17
  18 If your python binary is in a non-standard location or has a
  19 non-standard name, run the following instead:
  20
  21     export PYTHON=/path/to/python
  22     $PYTHON ./configure
  23     make
  24     make install
  25
  26 Windows:
  27
  28     vcbuild.bat
  29
  30 ### To run the tests:
  31
  32 Unix/Macintosh:
  33
  34     make test
  35
  36 Windows:
  37
  38     vcbuild.bat test
  39
  40 ### To build the documentation:
  41
  42     make doc
  43
  44 ### To read the documentation:
  45
  46     man doc/node.1
  47
  48 Resources for Newcomers
  49 ---
  50   - [The Wiki](https://github.com/joyent/node/wiki)
  51   - [nodejs.org](http://nodejs.org/)
  52   - [how to install node.js and npm (node package manager)](http://joyeur.com/2010/12/10/installing-node-and-npm/)
  53   - [list of modules](https://github.com/joyent/node/wiki/modules)
  54   - [searching the npm registry](http://search.npmjs.org/)
  55   - [list of companies and projects using node](https://github.com/joyent/node/wiki/Projects,-Applications,-and-Companies-Using-Node)
  56   - [node.js mailing list](http://groups.google.com/group/nodejs)
  57   - irc chatroom, [#node.js on freenode.net](http://webchat.freenode.net?channels=node.js&uio=d4)
  58   - [community](https://github.com/joyent/node/wiki/Community)
  59   - [contributing](https://github.com/joyent/node/wiki/Contributing)
  60   - [big list of all the helpful wiki pages](https://github.com/joyent/node/wiki/_pages)