docs: Cross compilation

This commit is contained in:
Cheng Zhao 2015-07-02 15:54:14 +08:00
parent 2078e5736e
commit a367934b95

View file

@ -4,9 +4,9 @@
* Python 2.7.x. Some distributions like CentOS still use Python 2.6.x * 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`. so you may need to check your Python version with `python -V`.
* Node.js v0.12.x. There are various ways to install Node. One can download * 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. 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. 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) Or try repositories such as [NodeSource] (https://nodesource.com/blog/nodejs-v012-iojs-and-the-nodesource-linux-repositories)
* Clang 3.4 or later * Clang 3.4 or later
* Development headers of GTK+ and libnotify * Development headers of GTK+ and libnotify
@ -20,15 +20,13 @@ $ sudo apt-get install build-essential clang libdbus-1-dev libgtk2.0-dev \
libxss1 gcc-multilib g++-multilib libxss1 gcc-multilib g++-multilib
``` ```
Other distributions may offer similar packages for installation via package Other distributions may offer similar packages for installation via package
managers such as yum. Or one can compile from source code. managers such as yum. Or one can compile from source code.
## If You Use Virtual Machines For Building ## If You Use Virtual Machines For Building
If you plan to build electron on a virtual machine, you will need a fixed-size If you plan to build electron on a virtual machine, you will need a fixed-size
device container of at least 25 gigabytes in size. device container of at least 25 gigabytes in size.
## Getting the code ## Getting the code
@ -39,8 +37,8 @@ $ git clone https://github.com/atom/electron.git
## Bootstrapping ## Bootstrapping
The bootstrap script will download all necessary build dependencies and create The bootstrap script will download all necessary build dependencies and create
build project files. You must have Python 2.7.x for the script to succeed. 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 Downloading certain files could take a long time. Notice that we are using
`ninja` to build Electron so there is no `Makefile` generated. `ninja` to build Electron so there is no `Makefile` generated.
```bash ```bash
@ -48,6 +46,15 @@ $ cd electron
$ ./script/bootstrap.py -v $ ./script/bootstrap.py -v
``` ```
### 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
```
## Building ## Building
If you would like to build both `Release` and `Debug` targets: If you would like to build both `Release` and `Debug` targets:
@ -57,16 +64,16 @@ $ ./script/build.py
``` ```
This script will cause a very large Electron executable to be placed in This script will cause a very large Electron executable to be placed in
the directory `out/R`. The file size is in excess of 1.3 gigabytes. This the directory `out/R`. The file size is in excess of 1.3 gigabytes. This
happens because the Release target binary contains debugging symbols. happens because the Release target binary contains debugging symbols.
To reduce the file size, run the `create-dist.py` script: To reduce the file size, run the `create-dist.py` script:
```bash ```bash
$ ./script/create-dist.py $ ./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:
@ -75,23 +82,19 @@ You can also build the `Debug` target only:
$ ./script/build.py -c D $ ./script/build.py -c D
``` ```
After building is done, you can find the `electron` debug binary After building is done, you can find the `electron` debug binary under `out/D`.
under `out/D`.
## Cleaning ## Cleaning
To clean the build files: To clean the build files:
```bash ```bash
$ ./script/clean.py $ ./script/clean.py
``` ```
## Troubleshooting ## Troubleshooting
Make sure you have installed all the build dependencies. Make sure you have installed all the build dependencies.
## Tests ## Tests