Skip to content
Newer
Older
100644 75 lines (51 sloc) 2.09 KB
89e894b @mmalecki doc: add Travis CI build status image
mmalecki authored
1 Evented I/O for V8 javascript. [![Build Status](https://secure.travis-ci.org/joyent/node.png)](http://travis-ci.org/joyent/node)
3a05a6e @DTrejo newcomer resources in README
DTrejo authored
2 ===
3
779c93c merge vcbuild.bat and generate_projects.bat
Igor Zinkovsky authored
4 ### To build:
5
6c5fdd5 @bnoordhuis doc: document prerequisites in README
bnoordhuis authored
6 Prerequisites (Unix only):
7
89dcf22 @bnoordhuis doc: the build requires gcc 4.2 or newer
bnoordhuis authored
8 * GCC 4.2 or newer
6c5fdd5 @bnoordhuis doc: document prerequisites in README
bnoordhuis authored
9 * Python 2.6 or 2.7
10 * GNU Make 3.81 or newer
11 * libexecinfo (FreeBSD and OpenBSD only)
12
13 Unix/Macintosh:
3a05a6e @DTrejo newcomer resources in README
DTrejo authored
14
15 ./configure
16 make
17 make install
18
13d86a8 @bnoordhuis doc: document PYTHON env var in README
bnoordhuis authored
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
779c93c merge vcbuild.bat and generate_projects.bat
Igor Zinkovsky authored
27 Windows:
28
29 vcbuild.bat
30
b7f36e1 @bnoordhuis doc: link to pre-built binaries, add install note
bnoordhuis authored
31 You can download pre-built binaries for various operating systems from
32 [http://nodejs.org/download/](http://nodejs.org/download/). The Windows
33 and OS X installers will prompt you for the location to install to.
34 The tarballs are self-contained; you can extract them to a local directory
35 with:
36
37 tar xzf /path/to/node-<version>-<platform>-<arch>.tar.gz
38
39 Or system-wide with:
40
41 cd /usr/local && tar --strip-components 1 -xzf \
42 /path/to/node-<version>-<platform>-<arch>.tar.gz
43
779c93c merge vcbuild.bat and generate_projects.bat
Igor Zinkovsky authored
44 ### To run the tests:
45
46 Unix/Macintosh:
3a05a6e @DTrejo newcomer resources in README
DTrejo authored
47
48 make test
49
779c93c merge vcbuild.bat and generate_projects.bat
Igor Zinkovsky authored
50 Windows:
51
52 vcbuild.bat test
53
54 ### To build the documentation:
3a05a6e @DTrejo newcomer resources in README
DTrejo authored
55
56 make doc
57
779c93c merge vcbuild.bat and generate_projects.bat
Igor Zinkovsky authored
58 ### To read the documentation:
3a05a6e @DTrejo newcomer resources in README
DTrejo authored
59
60 man doc/node.1
61
62 Resources for Newcomers
63 ---
fc61134 @mmalecki doc: fix links
mmalecki authored
64 - [The Wiki](https://github.com/joyent/node/wiki)
3a05a6e @DTrejo newcomer resources in README
DTrejo authored
65 - [nodejs.org](http://nodejs.org/)
9fad8e5 @bnoordhuis doc: fix blog link in blog posts and README
bnoordhuis authored
66 - [how to install node.js and npm (node package manager)](http://www.joyent.com/blog/installing-node-and-npm/)
fc61134 @mmalecki doc: fix links
mmalecki authored
67 - [list of modules](https://github.com/joyent/node/wiki/modules)
4b69bcf @isaacs doc: s/search.npmjs.org/npmjs.org/
isaacs authored
68 - [searching the npm registry](http://npmjs.org/)
fc61134 @mmalecki doc: fix links
mmalecki authored
69 - [list of companies and projects using node](https://github.com/joyent/node/wiki/Projects,-Applications,-and-Companies-Using-Node)
3a05a6e @DTrejo newcomer resources in README
DTrejo authored
70 - [node.js mailing list](http://groups.google.com/group/nodejs)
71 - irc chatroom, [#node.js on freenode.net](http://webchat.freenode.net?channels=node.js&uio=d4)
fc61134 @mmalecki doc: fix links
mmalecki authored
72 - [community](https://github.com/joyent/node/wiki/Community)
73 - [contributing](https://github.com/joyent/node/wiki/Contributing)
74 - [big list of all the helpful wiki pages](https://github.com/joyent/node/wiki/_pages)
Something went wrong with that request. Please try again.