diff options
| author | Rich Trott <rtrott@gmail.com> | 2016-09-02 20:23:21 -0700 |
|---|---|---|
| committer | Rich Trott <rtrott@gmail.com> | 2016-09-06 14:59:01 -0700 |
| commit | 30dbc9d9610e82fc1c7186a79d61e2d06e512d08 (patch) | |
| tree | 67c9810a69777054ac20406c20136e0d38016a57 | |
| parent | a945244830ebe2a5d0a65c00f711e117a588e1f1 (diff) | |
| download | node-new-30dbc9d9610e82fc1c7186a79d61e2d06e512d08.tar.gz | |
doc: update BUILDING.md
* General copy-editing
* Move `[sudo] make install` step from general Unix build to own step
* Remove `make test-addons` as that is now covered by `make test`
* Standardize on `/path/to/foo` as used elsewhere in the doc
* Change `node -e` to `./node -e` to avoid using different node binary
PR-URL: https://github.com/nodejs/node/pull/8398
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
| -rw-r--r-- | BUILDING.md | 25 |
1 files changed, 11 insertions, 14 deletions
diff --git a/BUILDING.md b/BUILDING.md index a0978a8050..a9d806727e 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -1,6 +1,6 @@ ## Building Node.js -Depending on what platform or features you require the build process may +Depending on what platform or features you require, the build process may differ slightly. After you've successfully built a binary, running the test suite to validate that the binary works as intended is a good next step. @@ -25,13 +25,13 @@ On OS X, you will also need: * This step will install `gcc` and the related toolchain containing `make` On FreeBSD and OpenBSD, you may also need: -* libexecinfo (FreeBSD and OpenBSD only) +* libexecinfo +To build Node.js: ```console $ ./configure $ make -$ [sudo] make install ``` If your Python binary is in a non-standard location or has a @@ -41,7 +41,6 @@ non-standard name, run the following instead: $ export PYTHON=/path/to/python $ $PYTHON ./configure $ make -$ [sudo] make install ``` To run the tests: @@ -50,12 +49,6 @@ To run the tests: $ make test ``` -To run the native module tests: - -```console -$ make test-addons -``` - To run the npm test suite: *note: to run the suite on node v4 or earlier you must first* @@ -76,11 +69,9 @@ $ make doc If you have an existing Node.js you can build just the docs with: ```console -$ NODE=node make doc-only +$ NODE=/path/to/node make doc-only ``` -(Where `node` is the path to your executable.) - To read the documentation: ```console @@ -90,7 +81,13 @@ $ man doc/node.1 To test if Node.js was built correctly: ```console -$ node -e "console.log('Hello from Node.js ' + process.version)" +$ ./node -e "console.log('Hello from Node.js ' + process.version)" +``` + +To install this version of Node.js into a system directory: + +```console +$ [sudo] make install ``` |