Skip to content

Commit e9fc548

Browse files
lirantaltargos
authored andcommittedOct 2, 2024
doc: refresh instructions for building node from source
- Organize the prerequisites sub-header properly - Add a note about memory limit PR-URL: #53768 Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Michael Dawson <midawson@redhat.com>
1 parent 65b6fec commit e9fc548

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed
 

‎BUILDING.md

+6-5
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)
@@ -228,9 +228,10 @@ Consult previous versions of this document for older versions of Node.js:
228228

229229
## Building Node.js on supported platforms
230230

231-
### Note about Python
231+
### Prerequisites
232232

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

235236
### Unix and macOS
236237

@@ -623,7 +624,7 @@ vcpkg integrate remove
623624

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

626-
#### Prerequisites
627+
#### Windows Prerequisites
627628

628629
##### Option 1: Manual install
629630

0 commit comments

Comments
 (0)
Please sign in to comment.