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

104 lines
2.8 KiB
Markdown
Raw Normal View History

2014-02-20 10:39:24 +00:00
# Build instructions (Linux)
## Prerequisites
* Python 2.7.x. Some distributions like CentOS still use Python 2.6.x
so you may need to check your Python version with `python -V`.
2015-07-02 07:54:14 +00:00
* Node.js v0.12.x. There are various ways to install Node. One can download
source code from [Node.js] (http://nodejs.org) and compile from source.
Doing so permits installing Node to your own home directory as a standard user.
Or try repositories such as [NodeSource] (https://nodesource.com/blog/nodejs-v012-iojs-and-the-nodesource-linux-repositories)
* Clang 3.4 or later
* Development headers of GTK+ and libnotify
On Ubuntu, install the following libraries:
```bash
$ sudo apt-get install build-essential clang libdbus-1-dev libgtk2.0-dev \
libnotify-dev libgnome-keyring-dev libgconf2-dev \
libasound2-dev libcap-dev libcups2-dev libxtst-dev \
2015-06-05 01:03:45 +00:00
libxss1 gcc-multilib g++-multilib
```
2015-07-02 07:54:14 +00:00
Other distributions may offer similar packages for installation via package
managers such as yum. Or one can compile from source code.
2015-06-05 01:03:45 +00:00
## If You Use Virtual Machines For Building
If you plan to build electron on a virtual machine, you will need a fixed-size
2015-07-02 07:54:14 +00:00
device container of at least 25 gigabytes in size.
2015-06-05 01:03:45 +00:00
2014-02-20 10:39:24 +00:00
## Getting the code
```bash
2015-04-16 03:31:12 +00:00
$ git clone https://github.com/atom/electron.git
2014-02-20 10:39:24 +00:00
```
## Bootstrapping
The bootstrap script will download all necessary build dependencies and create
2015-07-02 07:54:14 +00:00
build project files. You must have Python 2.7.x for the script to succeed.
Downloading certain files could take a long time. Notice that we are using
2015-06-05 01:03:45 +00:00
`ninja` to build Electron so there is no `Makefile` generated.
2014-02-20 10:39:24 +00:00
```bash
2015-04-16 03:31:12 +00:00
$ cd electron
2014-12-08 17:07:00 +00:00
$ ./script/bootstrap.py -v
2014-02-20 10:39:24 +00:00
```
2015-07-02 07:54:14 +00:00
### Cross compilation
If you want to cross compile for `arm` or `ia32` targets, you can pass the
`--target_arch` parameter to the `bootstrap.py` script:
```bash
$ ./script/bootstrap.py -v --target_arch=arm
```
2014-02-20 10:39:24 +00:00
## Building
2015-06-05 01:03:45 +00:00
If you would like to build both `Release` and `Debug` targets:
2014-02-20 10:39:24 +00:00
```bash
$ ./script/build.py
```
2015-06-05 01:03:45 +00:00
This script will cause a very large Electron executable to be placed in
2015-07-02 07:54:14 +00:00
the directory `out/R`. The file size is in excess of 1.3 gigabytes. This
happens because the Release target binary contains debugging symbols.
2015-06-05 01:03:45 +00:00
To reduce the file size, run the `create-dist.py` script:
```bash
$ ./script/create-dist.py
```
2015-07-02 07:54:14 +00:00
This will put a working distribution with much smaller file sizes in
the `dist` directory. After running the create-dist.py script, you
2015-06-05 01:03:45 +00:00
may want to remove the 1.3+ gigabyte binary which is still in out/R.
You can also build the `Debug` target only:
2014-02-20 10:39:24 +00:00
```bash
2015-04-10 13:56:02 +00:00
$ ./script/build.py -c D
2014-02-20 10:39:24 +00:00
```
2015-07-02 07:54:14 +00:00
After building is done, you can find the `electron` debug binary under `out/D`.
## Cleaning
To clean the build files:
```bash
$ ./script/clean.py
```
2014-02-20 10:39:24 +00:00
## Troubleshooting
2015-07-02 07:54:14 +00:00
Make sure you have installed all the build dependencies.
2014-02-20 10:39:24 +00:00
## Tests
```bash
$ ./script/test.py
```