Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: update BUILDING.md #8398

Closed
wants to merge 1 commit into from
Closed

doc: update BUILDING.md #8398

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 11 additions & 14 deletions BUILDING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.

Expand All @@ -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
Expand All @@ -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:
Expand All @@ -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*
Expand All @@ -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
Expand All @@ -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
```


Expand Down