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 | * 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 | Windows:
|
28 |
|
29 | vcbuild.bat
|
30 |
|
31 | ### To run the tests:
|
32 |
|
33 | Unix/Macintosh:
|
34 |
|
35 | make test
|
36 |
|
37 | Windows:
|
38 |
|
39 | vcbuild.bat test
|
40 |
|
41 | ### To build the documentation:
|
42 |
|
43 | make doc
|
44 |
|
45 | ### To read the documentation:
|
46 |
|
47 | man doc/node.1
|
48 |
|
49 | Resources for Newcomers
|
50 | ---
|
51 | - [The Wiki](https://github.com/joyent/node/wiki)
|
52 | - [nodejs.org](http://nodejs.org/)
|
53 | - [how to install node.js and npm (node package manager)](http://joyeur.com/2010/12/10/installing-node-and-npm/)
|
54 | - [list of modules](https://github.com/joyent/node/wiki/modules)
|
55 | - [searching the npm registry](http://npmjs.org/)
|
56 | - [list of companies and projects using node](https://github.com/joyent/node/wiki/Projects,-Applications,-and-Companies-Using-Node)
|
57 | - [node.js mailing list](http://groups.google.com/group/nodejs)
|
58 | - irc chatroom, [#node.js on freenode.net](http://webchat.freenode.net?channels=node.js&uio=d4)
|
59 | - [community](https://github.com/joyent/node/wiki/Community)
|
60 | - [contributing](https://github.com/joyent/node/wiki/Contributing)
|
61 | - [big list of all the helpful wiki pages](https://github.com/joyent/node/wiki/_pages)
|