2016-06-18 13:26:26 +00:00
# Build Instructions (macOS)
2015-08-31 05:30:23 +00:00
2016-06-18 13:26:26 +00:00
Follow the guidelines below for building Electron on macOS.
2013-09-09 07:35:57 +00:00
2013-08-14 22:43:35 +00:00
## Prerequisites
2017-01-24 18:49:42 +00:00
* macOS >= 10.11.6
* [Xcode ](https://developer.apple.com/technologies/tools/ ) >= 8.2.1
2018-01-12 15:24:48 +00:00
* [node.js ](https://nodejs.org ) (external)
2018-05-16 21:19:49 +00:00
* Python 2.7 with support for TLS 1.2
2013-08-14 22:43:35 +00:00
2018-05-16 21:19:49 +00:00
## Python
Please also ensure that your system and Python version support at least TLS 1.2.
This depends on both your version of macOS and Python. For a quick test, run:
```sh
2018-08-12 21:01:46 +00:00
$ npm run check-tls
2018-05-16 21:19:49 +00:00
```
If the script returns that your configuration is using an outdated security
protocol, you can either update macOS to High Sierra or install a new version
of Python 2.7.x. To upgrade Python, use [Homebrew ](https://brew.sh/ ):
```sh
$ brew install python@2 & & brew link python@2 --force
```
If you are using Python as provided by Homebrew, you also need to install
2016-10-11 14:41:28 +00:00
the following Python modules:
2013-11-26 03:46:45 +00:00
2016-10-11 14:34:35 +00:00
* [pyobjc ](https://pythonhosted.org/pyobjc/install.html )
2013-11-26 03:46:45 +00:00
2017-01-20 05:19:07 +00:00
## macOS SDK
2018-05-08 05:16:09 +00:00
If you're developing Electron and don't plan to redistribute your
2017-01-20 05:19:07 +00:00
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.
2017-01-24 18:49:42 +00:00
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
2017-01-20 05:19:07 +00:00
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
2017-01-24 18:49:42 +00:00
that your Xcode 8.2.1 install is at `/Applications/Xcode.app` , run:
2017-01-20 05:19:07 +00:00
2017-11-24 10:13:57 +00:00
```sh
2017-01-24 18:49:42 +00:00
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/
2017-01-20 05:19:07 +00:00
```
2017-01-24 18:49:42 +00:00
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
2018-09-09 01:15:32 +00:00
## Building Electron
2013-08-14 22:43:35 +00:00
2018-09-09 01:15:32 +00:00
See [Build Instructions: GN ](build-instructions-gn.md ).
