docs: update Windows build instructions (#14797)

This commit is contained in:
Martin Mädler 2018-10-22 22:40:39 +02:00 committed by John Kleinschmidt
parent 5e199152e2
commit a4fefbe836
2 changed files with 28 additions and 4 deletions

View file

@ -72,6 +72,9 @@ $ gclient sync --with_branch_heads --with_tags
# This will take a while, go get a coffee.
```
> Instead of `https://github.com/electron/electron`, you can use your own fork
> here (something like `https://github.com/<username>/electron`).
#### A note on pulling/pushing
If you intend to `git pull` or `git push` from the official `electron`
@ -108,6 +111,13 @@ $ export GN_EXTRA_ARGS="${GN_EXTRA_ARGS} cc_wrapper=\"${PWD}/electron/external_b
$ gn gen out/Debug --args="import(\"//electron/build/args/debug.gn\") $GN_EXTRA_ARGS"
```
Or on Windows (without the optional argument):
```sh
$ cd src
$ set CHROMIUM_BUILDTOOLS_PATH=%cd%\buildtools
$ gn gen out/Debug --args="import(\"//electron/build/args/debug.gn\")"
```
This will generate a build directory `out/Debug` under `src/` with
debug build configuration. You can replace `Debug` with another name,
but it should be a subdirectory of `out`.

View file

@ -7,12 +7,26 @@ Follow the guidelines below for building Electron on Windows.
* Windows 10 / Server 2012 R2 or higher
* Visual Studio 2017 15.7.2 or higher - [download VS 2017 Community Edition for
free](https://www.visualstudio.com/vs/)
* [Python 2.7](http://www.python.org/download/releases/2.7/)
* [Python 2.7.10 or higher](http://www.python.org/download/releases/2.7/)
* Contrary to the `depot_tools` setup instructions linked below, you will need
to use your locally installed Python with at least version 2.7.10 (with
support for TLS 1.2). To do so, make sure that in **PATH**, your locally
installed Python comes before the `depot_tools` folder. Right now
`depot_tools` still comes with Python 2.7.6, which will cause the `gclient`
command to fail (see https://crbug.com/868864).
* [Python for Windows (pywin32) Extensions](https://pypi.org/project/pywin32/#files)
is also needed in ordner to run the build process.
* [Node.js](https://nodejs.org/download/)
* [Git](http://git-scm.com)
* [Debugging Tools for Windows](https://msdn.microsoft.com/en-us/library/windows/hardware/ff551063.aspx)
if you plan on creating a full distribution since `symstore.exe` is used for
creating a symbol store from `.pdb` files.
* Debugging Tools for Windows of Windows SDK 10.0.15063.468 if you plan on
creating a full distribution since `symstore.exe` is used for creating a symbol
store from `.pdb` files.
* Different versions of the SDK can be installed side by side. To install the
SDK, open Visual Studio Installer, select
`Change``Individual Components`, scroll down and select the appropriate
Windows SDK to install. Another option would be to look at the
[Windows SDK and emulator archive](https://developer.microsoft.com/de-de/windows/downloads/sdk-archive)
and download the standalone version of the SDK respectively.
If you don't currently have a Windows installation,
[dev.microsoftedge.com](https://developer.microsoft.com/en-us/microsoft-edge/tools/vms/)