Skip to content

Commit b305db8

Browse files
TrottMylesBorins
authored andcommitted
doc: edit BUILDING.md
Minor edits to BUILDING.md to keep sentences short and clear. PR-URL: #24243 Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Refael Ackermann <[email protected]>
1 parent 4054c24 commit b305db8

File tree

1 file changed

+10
-16
lines changed

1 file changed

+10
-16
lines changed

BUILDING.md

+10-16
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,7 @@ There are three support tiers:
6969
### Supported platforms
7070

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

7574
| System | Support type | Version | Architectures | Notes |
7675
|--------------|--------------|----------------------------------|----------------------|------------------|
@@ -134,21 +133,20 @@ OpenSSL-1.1.0 requires the following assembler version for use of asm
134133
support on x86_64 and ia32.
135134

136135
* gas (GNU assembler) version 2.23 or higher
137-
* xcode version 5.0 or higher
136+
* Xcode version 5.0 or higher
138137
* llvm version 3.3 or higher
139138
* nasm version 2.10 or higher in Windows
140139

141-
Otherwise `configure` will fail with an error. This can be avoided by
142-
either providing a newer assembler as per the list above or by
143-
using the `--openssl-no-asm` flag.
140+
If compiling without one of the above, use `configure` with the
141+
`--openssl-no-asm` flag. Otherwise, `configure` will fail.
144142

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

148146
## Building Node.js on supported platforms
149147

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

153151
### Unix/macOS
154152

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

162-
On macOS, you will need to install the `Xcode Command Line Tools` by running
160+
On macOS, install the `Xcode Command Line Tools` by running
163161
`xcode-select --install`. Alternatively, if you already have the full Xcode
164162
installed, you can find them under the menu `Xcode -> Open Developer Tool ->
165163
More Developer Tools...`. This step will install `clang`, `clang++`, and
@@ -180,13 +178,9 @@ $ ./configure
180178
$ make -j4
181179
```
182180

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

191185
Note that the above requires that `python` resolve to Python 2.6 or 2.7
192186
and not a newer version.

0 commit comments

Comments
 (0)