Skip to content

Commit 8b7aa00

Browse files
committed
doc: edit BUILDING.md
Minor edits to BUILDING.md to keep sentences short and clear.
1 parent 1f6c4ba commit 8b7aa00

File tree

1 file changed

+10
-13
lines changed

1 file changed

+10
-13
lines changed

BUILDING.md

+10-13
Original file line numberDiff line numberDiff line change
@@ -70,8 +70,7 @@ There are three support tiers:
7070
### Supported platforms
7171

7272
The community does not build or test against end-of-life distributions (EoL).
73-
Thus, we do not recommend that you use Node.js on end-of-life or unsupported
74-
platforms in production.
73+
For production applications, run Node.js on supported platforms only.
7574

7675
| System | Support type | Version | Architectures | Notes |
7776
| ------------ | ------------ | ------------------------------- | ---------------- | ----------------------------- |
@@ -139,17 +138,16 @@ support on x86_64 and ia32.
139138
* llvm version 3.3 or higher
140139
* nasm version 2.10 or higher in Windows
141140

142-
Otherwise `configure` will fail with an error. This can be avoided by
143-
either providing a newer assembler as per the list above or by
144-
using the `--openssl-no-asm` flag.
141+
Otherwise `configure` will fail with an error. Avoid this by either providing a
142+
newer assembler as per the list above or by using the `--openssl-no-asm` flag.
145143

146144
The forthcoming OpenSSL-1.1.1 will have different requirements. Please refer to
147145
https://www.openssl.org/docs/man1.1.1/man3/OPENSSL_ia32cap.html for details.
148146

149147
## Building Node.js on supported platforms
150148

151-
*Note:* All prerequisites can be easily installed by following
152-
[this bootstrapping guide](https://github.com/nodejs/node/blob/master/tools/bootstrap/README.md).
149+
The [bootstrapping guide](https://github.com/nodejs/node/blob/master/tools/bootstrap/README.md)
150+
explains how to install all prerequisites.
153151

154152
### Unix/macOS
155153

@@ -160,7 +158,7 @@ The forthcoming OpenSSL-1.1.1 will have different requirements. Please refer to
160158
* Python 2.6 or 2.7
161159
* GNU Make 3.81 or newer
162160

163-
On macOS, you will need to install the `Xcode Command Line Tools` by running
161+
On macOS, install the `Xcode Command Line Tools` by running
164162
`xcode-select --install`. Alternatively, if you already have the full Xcode
165163
installed, you can find them under the menu `Xcode -> Open Developer Tool ->
166164
More Developer Tools...`. This step will install `clang`, `clang++`, and
@@ -181,11 +179,10 @@ $ ./configure
181179
$ make -j4
182180
```
183181

184-
Running `make` with the `-j4` flag will cause it to run 4 compilation jobs
185-
concurrently which may significantly reduce build time. The number after `-j`
186-
can be changed to best suit the number of processor cores on your machine. If
187-
you run into problems running `make` with concurrency, try running it without
188-
the `-j4` flag. See the
182+
The `-j4` option will cause `make` to run 4 simultaneous compilation jobs which
183+
may reduce build time. Change the number after `-j` to best suit the number of
184+
processor cores on your machine. If you run into problems running `make` with
185+
concurrency, try running it without the `-j4` flag. See the
189186
[GNU Make Documentation](https://www.gnu.org/software/make/manual/html_node/Parallel.html)
190187
for more information.
191188

0 commit comments

Comments
 (0)