doc: mention execArgv in setupMaster

[platform/upstream/nodejs.git] / README.md

diff --git a/README.md b/README.md
index 728b635..12fd05a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,34 +1,74 @@
-Evented I/O for V8 javascript.
+Evented I/O for V8 javascript. [![Build Status](https://secure.travis-ci.org/joyent/node.png)](http://travis-ci.org/joyent/node)
 ===
 
-To build:
+### To build:
+
+Prerequisites (Unix only):
+
+    * GCC 4.2 or newer
+    * Python 2.6 or 2.7
+    * GNU Make 3.81 or newer
+    * libexecinfo (FreeBSD and OpenBSD only)
+
+Unix/Macintosh:
 
     ./configure
     make
     make install
 
-To run the tests:
+If your python binary is in a non-standard location or has a
+non-standard name, run the following instead:
+
+    export PYTHON=/path/to/python
+    $PYTHON ./configure
+    make
+    make install
+
+Windows:
+
+    vcbuild.bat
+
+You can download pre-built binaries for various operating systems from
+[http://nodejs.org/download/](http://nodejs.org/download/).  The Windows
+and OS X installers will prompt you for the location to install to.
+The tarballs are self-contained; you can extract them to a local directory
+with:
+
+    tar xzf /path/to/node-<version>-<platform>-<arch>.tar.gz
+
+Or system-wide with:
+
+    cd /usr/local && tar --strip-components 1 -xzf \
+                         /path/to/node-<version>-<platform>-<arch>.tar.gz
+
+### To run the tests:
+
+Unix/Macintosh:
 
     make test
 
-To build the documentation:
+Windows:
+
+    vcbuild.bat test
+
+### To build the documentation:
 
     make doc
 
-To read the documentation:
+### To read the documentation:
 
     man doc/node.1
 
 Resources for Newcomers
 ---
-  - [The Wiki](https://github.com/ry/node/wiki)
+  - [The Wiki](https://github.com/joyent/node/wiki)
   - [nodejs.org](http://nodejs.org/)
-  - [how to install node.js and npm (node package manager)](http://joyeur.com/2010/12/10/installing-node-and-npm/)
-  - [list of modules](https://github.com/ry/node/wiki/modules)
-  - [searching the npm registry](http://search.npmjs.org/)
-  - [list of companies and projects using node](http://github.com/ry/node/wiki)
+  - [how to install node.js and npm (node package manager)](http://www.joyent.com/blog/installing-node-and-npm/)
+  - [list of modules](https://github.com/joyent/node/wiki/modules)
+  - [searching the npm registry](http://npmjs.org/)
+  - [list of companies and projects using node](https://github.com/joyent/node/wiki/Projects,-Applications,-and-Companies-Using-Node)
   - [node.js mailing list](http://groups.google.com/group/nodejs)
   - irc chatroom, [#node.js on freenode.net](http://webchat.freenode.net?channels=node.js&uio=d4)
-  - [community](https://github.com/ry/node/wiki/Community)
-  - [contributing](https://github.com/ry/node/wiki/Contributing)
-  - [big list of all the helpful wiki pages](https://github.com/ry/node/wiki/_pages)
+  - [community](https://github.com/joyent/node/wiki/Community)
+  - [contributing](https://github.com/joyent/node/wiki/Contributing)
+  - [big list of all the helpful wiki pages](https://github.com/joyent/node/wiki/_pages)