electron/docs/development/build-instructions-macos.md

# Build Instructions (macOS)

Follow the guidelines below for building Electron on macOS.

## Prerequisites

* macOS >= 10.11.6
* [Xcode](https://developer.apple.com/technologies/tools/) >= 9.0.0
* [node.js](https://nodejs.org) (external)
* Python 2.7 with support for TLS 1.2

## 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
$ npm run check-tls
```

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
the following Python modules:

* [pyobjc](https://pythonhosted.org/pyobjc/install.html)

## macOS SDK

If you're developing Electron and don't plan to redistribute your
custom Electron build, you may skip this section.

Official Electron builds are built with [Xcode 9.4.1](http://adcdownload.apple.com/Developer_Tools/Xcode_9.4.1/Xcode_9.4.1.xip), and the MacOS 10.13 SDK.  Building with a newer SDK works too, but the releases currently use the 10.13 SDK.

## Building Electron

See [Build Instructions: GN](build-instructions-gn.md).
Replace OS X and Mac OS with macOS 2016-06-18 13:26:26 +00:00			`# Build Instructions (macOS)`
Standardize build mac 2015-08-31 05:30:23 +00:00
Replace OS X and Mac OS with macOS 2016-06-18 13:26:26 +00:00			`Follow the guidelines below for building Electron on macOS.`
doc: Add titles for all pages. 2013-09-09 07:35:57 +00:00
Move wiki content to docs dir 2013-08-14 22:43:35 +00:00			`## Prerequisites`

Update build doc to Xcode 8.2.1 2017-01-24 18:49:42 +00:00			`* macOS >= 10.11.6`
build: update circle base image and mac docs for 10.13 SDK 2019-03-22 01:31:28 +00:00			`* [Xcode](https://developer.apple.com/technologies/tools/) >= 9.0.0`
[Docs] Fix URLs and Paths (#11584) * Fix URLs and Paths in docs/ * Avoiding link break to /docs/development/updgrading-chrome.md * Fix URLs and Paths in docs/ #2 * Removed double spaces in docs 2018-01-12 15:24:48 +00:00			`* [node.js](https://nodejs.org) (external)`
docs: Document Python TLS requirements (#12276) * :wrench: Add simple test script * :memo: Add documentation * :wrench: It works, use it * :wrench: Make the linter happy * :wrench: Check on bootstrap * Trivial copyediting s/operation system/operating system/ 2018-05-16 21:19:49 +00:00			`* Python 2.7 with support for TLS 1.2`
Move wiki content to docs dir 2013-08-14 22:43:35 +00:00
docs: Document Python TLS requirements (#12276) * :wrench: Add simple test script * :memo: Add documentation * :wrench: It works, use it * :wrench: Make the linter happy * :wrench: Check on bootstrap * Trivial copyediting s/operation system/operating system/ 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
refactor: add 'npm run bootstrap', 'npm run build' (#14034) * docs: update package.json and build docs * fix build release * address feedback from review * whoops forgot one * fix build script * address feedback from review 2018-08-12 21:01:46 +00:00			`$ npm run check-tls`
docs: Document Python TLS requirements (#12276) * :wrench: Add simple test script * :memo: Add documentation * :wrench: It works, use it * :wrench: Make the linter happy * :wrench: Check on bootstrap * Trivial copyediting s/operation system/operating system/ 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`
Small fix to grammar in Build instructions (macOS) 2016-10-11 14:41:28 +00:00			`the following Python modules:`
Mention that pyobjc is needed for homebrew python. 2013-11-26 03:46:45 +00:00
Adds link to PyObjC installation instructions 2016-10-11 14:34:35 +00:00			`* [pyobjc](https://pythonhosted.org/pyobjc/install.html)`
Mention that pyobjc is needed for homebrew python. 2013-11-26 03:46:45 +00:00
Document use of Xcode 7.3.1 with 10.10 SDK for release builds 2017-01-20 05:19:07 +00:00			`## macOS SDK`

Remove more words (#12852) * remove 'basically' from docs * remove 'simply' from docs * remove most uses of 'just' from docs 2018-05-08 05:16:09 +00:00			`If you're developing Electron and don't plan to redistribute your`
Document use of Xcode 7.3.1 with 10.10 SDK for release builds 2017-01-20 05:19:07 +00:00			`custom Electron build, you may skip this section.`

build: update circle base image and mac docs for 10.13 SDK 2019-03-22 01:31:28 +00:00			`Official Electron builds are built with [Xcode 9.4.1](http://adcdownload.apple.com/Developer_Tools/Xcode_9.4.1/Xcode_9.4.1.xip), and the MacOS 10.13 SDK. Building with a newer SDK works too, but the releases currently use the 10.13 SDK.`
Update build doc to Xcode 8.2.1 2017-01-24 18:49:42 +00:00
build: remove gyp build files (#14097) * build: remove gyp build files * docs: update build instructions * build: temporary restore electron.gyp * build: do not update Electron version in the electron.gyp * chore: remove unused submodules * ci: remove obsolete CI scripts and configs * chore: remove obsolete scripts * chore: remove obsolete functions from lib/util.py * ci: send Slack notification for nightly build results 2018-09-09 01:15:32 +00:00			`## Building Electron`
Move wiki content to docs dir 2013-08-14 22:43:35 +00:00
build: remove gyp build files (#14097) * build: remove gyp build files * docs: update build instructions * build: temporary restore electron.gyp * build: do not update Electron version in the electron.gyp * chore: remove unused submodules * ci: remove obsolete CI scripts and configs * chore: remove obsolete scripts * chore: remove obsolete functions from lib/util.py * ci: send Slack notification for nightly build results 2018-09-09 01:15:32 +00:00			`See [Build Instructions: GN](build-instructions-gn.md).`