Merge remote branch 'origin/v0.6'
[platform/upstream/nodejs.git] / 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 Unix/Macintosh (requires python >= 2.5.2):
7
8     ./configure
9     make
10     make install
11
12 Windows:
13
14     vcbuild.bat
15
16 ### To run the tests:
17
18 Unix/Macintosh:
19
20     make test
21
22 Windows:
23
24     vcbuild.bat test
25
26 ### To build the documentation:
27
28     make doc
29
30 ### To read the documentation:
31
32     man doc/node.1
33
34 Resources for Newcomers
35 ---
36   - [The Wiki](https://github.com/joyent/node/wiki)
37   - [nodejs.org](http://nodejs.org/)
38   - [how to install node.js and npm (node package manager)](http://joyeur.com/2010/12/10/installing-node-and-npm/)
39   - [list of modules](https://github.com/joyent/node/wiki/modules)
40   - [searching the npm registry](http://search.npmjs.org/)
41   - [list of companies and projects using node](https://github.com/joyent/node/wiki/Projects,-Applications,-and-Companies-Using-Node)
42   - [node.js mailing list](http://groups.google.com/group/nodejs)
43   - irc chatroom, [#node.js on freenode.net](http://webchat.freenode.net?channels=node.js&uio=d4)
44   - [community](https://github.com/joyent/node/wiki/Community)
45   - [contributing](https://github.com/joyent/node/wiki/Contributing)
46   - [big list of all the helpful wiki pages](https://github.com/joyent/node/wiki/_pages)