mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

Merge pull request #10138 from electron/improve-linux-build-instructions

Browse source 
improve linux build instructions
This commit is contained in:
John Kleinschmidt 2017-07-28 16:36:04 -04:00 committed by GitHub
commit d38c9a4644
1 changed files with 32 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

48
docs/development/build-instructions-linux.md
View file

@ -8,10 +8,10 @@ Follow the guidelines below for building Electron on Linux.
* Python 2.7.x. Some distributions like CentOS 6.x still use Python 2.6.x * Python 2.7.x. Some distributions like CentOS 6.x still use Python 2.6.x
so you may need to check your Python version with `python -V`. so you may need to check your Python version with `python -V`.
* Node.js. There are various ways to install Node. You can download * Node.js. There are various ways to install Node. You can download
source code from [Node.js](http://nodejs.org) and compile from source. source code from [nodejs.org](http://nodejs.org) and compile it.
Doing so permits installing Node on your own home directory as a standard user. Doing so permits installing Node on 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). Or try repositories such as [NodeSource](https://nodesource.com/blog/nodejs-v012-iojs-and-the-nodesource-linux-repositories).
* Clang 3.4 or later. * [clang](https://clang.llvm.org/get_started.html) 3.4 or later.
* Development headers of GTK+ and libnotify. * Development headers of GTK+ and libnotify.
On Ubuntu, install the following libraries: On Ubuntu, install the following libraries:
@ -48,7 +48,7 @@ managers such as pacman. Or one can compile from source code.
## Getting the Code ## Getting the Code
```bash ```bash
$ git clone https://github.com/electron/electron.git $ git clone https://github.com/electron/electron
``` ```
## Bootstrapping ## Bootstrapping
@ -60,7 +60,7 @@ Downloading certain files can take a long time. Notice that we are using
```bash ```bash
$ cd electron $ cd electron
$ ./script/bootstrap.py -v $ ./script/bootstrap.py --verbose
``` ```
### Cross compilation ### Cross compilation
@ -73,7 +73,7 @@ $ sudo apt-get install libc6-dev-armhf-cross linux-libc-dev-armhf-cross \
g++-arm-linux-gnueabihf g++-arm-linux-gnueabihf
``` ```
And to cross compile for `arm` or `ia32` targets, you should pass the And to cross-compile for `arm` or `ia32` targets, you should pass the
`--target_arch` parameter to the `bootstrap.py` script: `--target_arch` parameter to the `bootstrap.py` script:
```bash ```bash
@ -98,7 +98,7 @@ $ ./script/create-dist.py
``` ```
This will put a working distribution with much smaller file sizes in This will put a working distribution with much smaller file sizes in
the `dist` directory. After running the create-dist.py script, you the `dist` directory. After running the `create-dist.py` script, you
may want to remove the 1.3+ gigabyte binary which is still in `out/R`. may want to remove the 1.3+ gigabyte binary which is still in `out/R`.
You can also build the `Debug` target only: You can also build the `Debug` target only:
@ -143,17 +143,29 @@ See [Build System Overview: Tests](build-system-overview.md#tests)
## Advanced topics ## Advanced topics
The default building configuration is targeted for major desktop Linux The default building configuration is targeted for major desktop Linux
distributions, to build for a specific distribution or device, following distributions. To build for a specific distribution or device, the following
information may help you. information may help you.
### Building `libchromiumcontent` locally ### Building `libchromiumcontent` locally
To avoid using the prebuilt binaries of `libchromiumcontent`, you can pass the To avoid using the prebuilt binaries of `libchromiumcontent`, you can build `libchromiumcontent` locally. To do so, follow these steps:
`--build_libchromiumcontent` switch to `bootstrap.py` script: 1. Install [depot_tools](https://chromium.googlesource.com/chromium/src/+/master/docs/linux_build_instructions.md#Install)
2. Install [additional build dependencies](https://chromium.googlesource.com/chromium/src/+/master/docs/linux_build_instructions.md#Install-additional-build-dependencies)
3. Fetch the git submodules:
```bash ```bash
$ ./script/bootstrap.py -v --build_libchromiumcontent $ git submodule update --init --recursive
``` ```
4. Copy the .gclient config file
```bash
$ cp vendor/libchromiumcontent/.gclient .
```
5. Pass the `--build_libchromiumcontent` switch to `bootstrap.py` script:
```bash
$ ./script/bootstrap.py -v --build_libchromiumcontent
```
Note that by default the `shared_library` configuration is not built, so you can Note that by default the `shared_library` configuration is not built, so you can
only build `Release` version of Electron if you use this mode: only build `Release` version of Electron if you use this mode:
@ -164,10 +176,12 @@ $ ./script/build.py -c R
### Using system `clang` instead of downloaded `clang` binaries ### Using system `clang` instead of downloaded `clang` binaries
By default Electron is built with prebuilt `clang` binaries provided by Chromium By default Electron is built with prebuilt
project. If for some reason you want to build with the `clang` installed in your [`clang`](https://clang.llvm.org/get_started.html) binaries provided by the
system, you can call `bootstrap.py` with `--clang_dir=<path>` switch. By passing Chromium project. If for some reason you want to build with the `clang`
it the build script will assume the `clang` binaries reside in `<path>/bin/`. installed in your system, you can call `bootstrap.py` with `--clang_dir=<path>`
switch. By passing it the build script will assume the `clang` binaries reside
in `<path>/bin/`.
For example if you installed `clang` under `/user/local/bin/clang`: For example if you installed `clang` under `/user/local/bin/clang`:
@ -176,7 +190,7 @@ $ ./script/bootstrap.py -v --build_libchromiumcontent --clang_dir /usr/local
$ ./script/build.py -c R $ ./script/build.py -c R
``` ```
### Using other compilers other than `clang` ### Using compilers other than `clang`
To build Electron with compilers like `g++`, you first need to disable `clang` To build Electron with compilers like `g++`, you first need to disable `clang`
with `--disable_clang` switch first, and then set `CC` and `CXX` environment with `--disable_clang` switch first, and then set `CC` and `CXX` environment