diff --git a/README.md b/README.md index bbd4b96..b48b192 100644 --- a/README.md +++ b/README.md @@ -65,7 +65,7 @@ yarn run build:native ``` On Windows, this will automatically determine the architecture to build for based -on the environment (ie. set up by vcvarsall.bat). +on the environment. Make sure that you have all the [tools required to perform the native modules build](docs/windows-requirements.md) Now you can build the package: diff --git a/docs/windows-requirements.md b/docs/windows-requirements.md new file mode 100644 index 0000000..6ff446e --- /dev/null +++ b/docs/windows-requirements.md @@ -0,0 +1,26 @@ +# Windows + +## Requirements to build native modules + +If you want to build native modules, make sure that the following tools are installed on your system. + +- [Node 14](https://nodejs.org) +- [Python 3](https://www.python.org/downloads/) +- [Strawberry Perl](https://strawberryperl.com/) +- [Rust](https://rustup.rs/) +- [Build Tools for Visual Studio 2019](https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2019) with the following configuration: + - On the Workloads tab: + - Desktop & Mobile -> C++ build tools + - On the Individual components tab: + - MSVC VS 2019 C++ build tools + - Windows 10 SDK (latest version available) + - C++ CMake tools for Windows + +Once installed make sure all those utilities are accessible in your `PATH`. +In order to load all the C++ utilities installed by Visual Studio you can run the following in a terminal window. + +``` +call "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvarsall.bat" amd64 +``` + +You can replace `amd64` with `x86` depending on your CPU architecture.