From 6d6f79cf66b4958e95da83fcee2775fc7bb7ae1d Mon Sep 17 00:00:00 2001 From: Liran Tal Date: Mon, 8 Jul 2024 22:23:16 +0300 Subject: [PATCH] doc: refresh instructions for building node from source - Organize the prerequisites sub-header properly - Add a note about memory limit PR-URL: https://github.com/nodejs/node/pull/53768 Reviewed-By: Trivikram Kamat Reviewed-By: Michael Dawson --- BUILDING.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/BUILDING.md b/BUILDING.md index c0fd9468b533ec..3dde87c1999230 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -19,7 +19,7 @@ file a new issue. * [OpenSSL asm support](#openssl-asm-support) * [Previous versions of this document](#previous-versions-of-this-document) * [Building Node.js on supported platforms](#building-nodejs-on-supported-platforms) - * [Note about Python](#note-about-python) + * [Prerequisites](#prerequisites) * [Unix and macOS](#unix-and-macos) * [Unix prerequisites](#unix-prerequisites) * [macOS prerequisites](#macos-prerequisites) @@ -33,7 +33,7 @@ file a new issue. * [Speeding up frequent rebuilds when developing](#speeding-up-frequent-rebuilds-when-developing) * [Troubleshooting Unix and macOS builds](#troubleshooting-unix-and-macos-builds) * [Windows](#windows) - * [Prerequisites](#prerequisites) + * [Windows Prerequisites](#windows-prerequisites) * [Option 1: Manual install](#option-1-manual-install) * [Option 2: Automated install with Boxstarter](#option-2-automated-install-with-boxstarter) * [Building Node.js](#building-nodejs-2) @@ -222,9 +222,10 @@ Consult previous versions of this document for older versions of Node.js: ## Building Node.js on supported platforms -### Note about Python +### Prerequisites -The Node.js project supports Python >= 3 for building and testing. +* Python support: the Node.js project supports Python >= 3.6 for building and testing. +* Memory: at least 8GB of RAM is typically required when compiling with 4 parallel jobs (e.g: `make -j4`) ### Unix and macOS @@ -612,7 +613,7 @@ vcpkg integrate remove Refs: #24448, , [vcpkg](https://github.com/microsoft/vcpkg/) -#### Prerequisites +#### Windows Prerequisites ##### Option 1: Manual install