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