Merge pull request #8452 from electron/document-build

Document toolchains used for building official Electron releases
This commit is contained in:
Kevin Sawicki 2017-01-24 10:53:33 -08:00 committed by GitHub
commit 0ca5ad754e
2 changed files with 29 additions and 5 deletions

View file

@ -4,8 +4,8 @@ Follow the guidelines below for building Electron on macOS.
## Prerequisites
* macOS >= 10.8
* [Xcode](https://developer.apple.com/technologies/tools/) >= 5.1
* macOS >= 10.11.6
* [Xcode](https://developer.apple.com/technologies/tools/) >= 8.2.1
* [node.js](http://nodejs.org) (external)
If you are using the Python downloaded by Homebrew, you also need to install
@ -13,6 +13,32 @@ the following Python modules:
* [pyobjc](https://pythonhosted.org/pyobjc/install.html)
## macOS SDK
If you're simply developing Electron and don't plan to redistribute your
custom Electron build, you may skip this section.
For certain features (e.g. pinch-zoom) to work properly, you must target the
macOS 10.10 SDK.
Official Electron builds are built with [Xcode 8.2.1](http://adcdownload.apple.com/Developer_Tools/Xcode_8.2.1/Xcode_8.2.1.xip), which does not contain
the 10.10 SDK by default. To obtain it, first download and mount the
[Xcode 6.4](http://developer.apple.com/devcenter/download.action?path=/Developer_Tools/Xcode_6.4/Xcode_6.4.dmg)
DMG.
Then, assuming that the Xcode 6.4 DMG has been mounted at `/Volumes/Xcode` and
that your Xcode 8.2.1 install is at `/Applications/Xcode.app`, run:
```bash
cp -r /Volumes/Xcode/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX10.10.sdk /Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/
```
You will also need to enable Xcode to build against the 10.10 SDK:
- Open `/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Info.plist`
- Set the `MinimumSDKVersion` to `10.10`
- Save the file
## Getting the Code
```bash

View file

@ -5,7 +5,7 @@ Follow the guidelines below for building Electron on Windows.
## Prerequisites
* Windows 7 / Server 2008 R2 or higher
* Visual Studio 2015 - [download VS 2015 Community Edition for
* Visual Studio 2015 Update 3 - [download VS 2015 Community Edition for
free](https://www.visualstudio.com/en-us/products/visual-studio-community-vs.aspx)
* [Python 2.7](http://www.python.org/download/releases/2.7/)
* [Node.js](http://nodejs.org/download/)
@ -22,8 +22,6 @@ building with Visual Studio will come in the future.
**Note:** Even though Visual Studio is not used for building, it's still
**required** because we need the build toolchains it provides.
**Note:** While older versions of Electron required Visual Studio 2013, Electron 1.1 and later does require Visual Studio 2015.
## Getting the Code
```powershell