Skip to content

Commit

Permalink
doc: updated building docs for windows
Browse files Browse the repository at this point in the history
PR-URL: #49767
Reviewed-By: Jacob Smith <jacob@frende.me>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
  • Loading branch information
ovflowd authored and targos committed Nov 11, 2023
1 parent 112cc7f commit f63a92b
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 15 deletions.
31 changes: 20 additions & 11 deletions BUILDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -576,9 +576,9 @@ to run it again before invoking `make -j4`.

* [Python 3.11](https://apps.microsoft.com/store/detail/python-311/9NRWMJP3717K)
* The "Desktop development with C++" workload from
[Visual Studio 2019](https://visualstudio.microsoft.com/vs/older-downloads/#visual-studio-2019-and-other-products) or
[Visual Studio 2022](https://visualstudio.microsoft.com/downloads/) or
the "C++ build tools" workload from the
[Build Tools](https://aka.ms/vs/16/release/vs_buildtools.exe),
[Build Tools](https://aka.ms/vs/17/release/vs_buildtools.exe),
with the default optional components
* Basic Unix tools required for some tests,
[Git for Windows](https://git-scm.com/download/win) includes Git Bash
Expand All @@ -590,11 +590,12 @@ to run it again before invoking `make -j4`.

Optional requirements to build the MSI installer package:

* The .NET SDK component from [Visual Studio 2019](https://visualstudio.microsoft.com/vs/older-downloads/#visual-studio-2019-and-other-products)
* The .NET SDK component from [Visual Studio 2022](https://visualstudio.microsoft.com/downloads/)
* This component can be installed via the Visual Studio Installer Application

Optional requirements for compiling for Windows 10 on ARM (ARM64):

* Visual Studio 15.9.0 or newer
* Visual Studio 17.6.0 or newer
* Visual Studio optional components
* Visual C++ compilers and libraries for ARM64
* Visual C++ ATL for ARM64
Expand All @@ -610,17 +611,17 @@ packages:
* [Git for Windows](https://chocolatey.org/packages/git) with the `git` and
Unix tools added to the `PATH`
* [Python 3.x](https://chocolatey.org/packages/python)
* [Visual Studio 2019 Build Tools](https://chocolatey.org/packages/visualstudio2019buildtools)
with [Visual C++ workload](https://chocolatey.org/packages/visualstudio2019-workload-vctools)
* [Visual Studio 2022 Build Tools](https://chocolatey.org/packages/visualstudio2022buildtools)
with [Visual C++ workload](https://chocolatey.org/packages/visualstudio2022-workload-vctools)
* [NetWide Assembler](https://chocolatey.org/packages/nasm)

To install Node.js prerequisites using
[Boxstarter WebLauncher](https://boxstarter.org/weblauncher), open
<https://boxstarter.org/package/nr/url?https://raw.githubusercontent.com/nodejs/node/HEAD/tools/bootstrap/windows_boxstarter>
with Internet Explorer or Edge browser on the target machine.

Alternatively, you can use PowerShell. Run those commands from an elevated
PowerShell terminal:
Alternatively, you can use PowerShell. Run those commands from
an elevated (Administrator) PowerShell terminal:

```powershell
Set-ExecutionPolicy Unrestricted -Force
Expand All @@ -635,8 +636,16 @@ disk space.

#### Building Node.js

If the path to your build directory contains a space or a non-ASCII character,
the build will likely fail.
* Remember to first clone the Node.js repository with the Git command
and head to the directory that Git created; If you haven't already
```powershell
git clone https://github.com/nodejs/node.git
cd node
```
* If the path to your build directory contains a space or a non-ASCII character,
the build will likely fail

To start the build process:

```powershell
.\vcbuild
Expand Down Expand Up @@ -697,7 +706,7 @@ This is the default option.
### Trimmed: `small-icu` (English only) support

In this configuration, only English data is included, but
the full `Intl` (ECMA-402) APIs. It does not need to download
the full `Intl` (ECMA-402) APIs. It does not need to download
any dependencies to function. You can add full data at runtime.

#### Unix/macOS
Expand Down
8 changes: 4 additions & 4 deletions tools/bootstrap/windows_boxstarter
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@

# Git and Unix tools will be added to the PATH
choco install git -params /GitAndUnixToolsOnPath -y
choco install python python2 -y
choco install python3 -y

# Installs VS 2019 Build Tools
choco install visualstudio2019buildtools -y
choco install visualstudio2019-workload-vctools -y --params="--add Microsoft.VisualStudio.Component.VC.Tools.ARM64 --add Microsoft.VisualStudio.Component.VC.ATL.ARM64"
# Installs VS 2022 Build Tools
choco install visualstudio2022buildtools -y
choco install visualstudio2022-workload-vctools -y --params="--add Microsoft.VisualStudio.Component.VC.Tools.ARM64 --add Microsoft.VisualStudio.Component.VC.ATL.ARM64"

# NASM
choco install nasm -y

0 comments on commit f63a92b

Please sign in to comment.