2015-09-01 04:13:05 +00:00
|
|
|
# Build Instructions (OS X)
|
2015-08-31 05:30:23 +00:00
|
|
|
|
2015-09-01 04:13:05 +00:00
|
|
|
Follow the guidelines below for building Electron on OS X.
|
2013-09-09 07:35:57 +00:00
|
|
|
|
2013-08-14 22:43:35 +00:00
|
|
|
## Prerequisites
|
|
|
|
|
2015-02-02 08:21:23 +00:00
|
|
|
* OS X >= 10.8
|
2014-05-09 02:04:13 +00:00
|
|
|
* [Xcode](https://developer.apple.com/technologies/tools/) >= 5.1
|
2015-08-31 05:30:23 +00:00
|
|
|
* [node.js](http://nodejs.org) (external)
|
2013-08-14 22:43:35 +00:00
|
|
|
|
2015-08-31 05:30:23 +00:00
|
|
|
If you are using the Python downloaded by Homebrew, you also need to install
|
2013-11-26 03:46:45 +00:00
|
|
|
following python modules:
|
|
|
|
|
|
|
|
* pyobjc
|
|
|
|
|
2015-08-31 05:30:23 +00:00
|
|
|
## Getting the Code
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
|
|
```bash
|
2015-04-16 03:31:12 +00:00
|
|
|
$ git clone https://github.com/atom/electron.git
|
2013-08-14 22:43:35 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
## Bootstrapping
|
|
|
|
|
2013-08-29 14:37:51 +00:00
|
|
|
The bootstrap script will download all necessary build dependencies and create
|
2015-08-31 05:30:23 +00:00
|
|
|
the build project files. Notice that we're using `ninja` to build Electron so
|
2013-08-29 14:37:51 +00:00
|
|
|
there is no Xcode project generated.
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
|
|
```bash
|
2015-04-16 03:31:12 +00:00
|
|
|
$ cd electron
|
2014-12-08 17:07:29 +00:00
|
|
|
$ ./script/bootstrap.py -v
|
2013-08-14 22:43:35 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
## Building
|
|
|
|
|
|
|
|
Build both `Release` and `Debug` targets:
|
|
|
|
|
|
|
|
```bash
|
|
|
|
$ ./script/build.py
|
|
|
|
```
|
|
|
|
|
|
|
|
You can also only build the `Debug` target:
|
|
|
|
|
|
|
|
```bash
|
2015-04-10 13:56:02 +00:00
|
|
|
$ ./script/build.py -c D
|
2013-08-14 22:43:35 +00:00
|
|
|
```
|
|
|
|
|
2015-04-16 03:31:12 +00:00
|
|
|
After building is done, you can find `Electron.app` under `out/D`.
|
2013-08-14 22:43:35 +00:00
|
|
|
|
2015-08-31 05:30:23 +00:00
|
|
|
## 32bit Support
|
2014-05-05 01:48:44 +00:00
|
|
|
|
2015-08-31 05:30:23 +00:00
|
|
|
Electron can only be built for a 64bit target on OS X and there is no plan to
|
2015-04-16 03:31:12 +00:00
|
|
|
support 32bit OS X in future.
|
2014-05-05 01:48:44 +00:00
|
|
|
|
2013-08-14 22:43:35 +00:00
|
|
|
## Tests
|
|
|
|
|
2015-08-31 05:30:23 +00:00
|
|
|
Test your changes conform to the project coding style using:
|
2015-08-08 20:25:27 +00:00
|
|
|
|
|
|
|
```bash
|
|
|
|
$ ./script/cpplint.py
|
|
|
|
```
|
|
|
|
|
|
|
|
Test functionality using:
|
|
|
|
|
2013-08-14 22:43:35 +00:00
|
|
|
```bash
|
|
|
|
$ ./script/test.py
|
|
|
|
```
|