Skip to content

Commit fe98fb3

Browse files
committed
doc: refresh instructions for building node from source
- Organize the prerequisites sub-header properly - Add a note about memory limit
1 parent cbd2c38 commit fe98fb3

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

BUILDING.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ file a new issue.
1919
* [OpenSSL asm support](#openssl-asm-support)
2020
* [Previous versions of this document](#previous-versions-of-this-document)
2121
* [Building Node.js on supported platforms](#building-nodejs-on-supported-platforms)
22-
* [Note about Python](#note-about-python)
22+
* [Prerequisites](#prerequisites)
2323
* [Unix and macOS](#unix-and-macos)
2424
* [Unix prerequisites](#unix-prerequisites)
2525
* [macOS prerequisites](#macos-prerequisites)
@@ -33,7 +33,7 @@ file a new issue.
3333
* [Speeding up frequent rebuilds when developing](#speeding-up-frequent-rebuilds-when-developing)
3434
* [Troubleshooting Unix and macOS builds](#troubleshooting-unix-and-macos-builds)
3535
* [Windows](#windows)
36-
* [Prerequisites](#prerequisites)
36+
* [Windows Prerequisites](#windows-prerequisites)
3737
* [Option 1: Manual install](#option-1-manual-install)
3838
* [Option 2: Automated install with Boxstarter](#option-2-automated-install-with-boxstarter)
3939
* [Building Node.js](#building-nodejs-2)
@@ -222,9 +222,10 @@ Consult previous versions of this document for older versions of Node.js:
222222

223223
## Building Node.js on supported platforms
224224

225-
### Note about Python
225+
### Prerequisites
226226

227-
The Node.js project supports Python >= 3 for building and testing.
227+
* Python support: the Node.js project supports Python >= 3.6 for building and testing.
228+
* Memory: at least 8GB of RAM is typically required when compiling with 4 parallel jobs (e.g: `make -j4`)
228229

229230
### Unix and macOS
230231

@@ -612,7 +613,7 @@ vcpkg integrate remove
612613

613614
Refs: #24448, <https://github.com/microsoft/vcpkg/issues/37518>, [vcpkg](https://github.com/microsoft/vcpkg/)
614615

615-
#### Prerequisites
616+
#### Windows Prerequisites
616617

617618
##### Option 1: Manual install
618619

0 commit comments

Comments
 (0)