docs/Developer-Guide_Build-Preparation.md

# What do I need?

- x86/x64 machine running any OS; 4G ram, SSD, quad core (recommended),
- [VirtualBox](https://www.virtualbox.org/wiki/Downloads) or similar virtualization software **(highly recommended with a minimum of 20GB hard disk space for the virtual disk image)**,
- Setting up VirtualBox and compile environment is easy following our [Vagrant tutorial](https://docs.armbian.com/Developer-Guide_Using-Vagrant/),
- when you don't want to build whole OS images (`KERNEL_ONLY=yes`) then [Docker](https://github.com/igorpecovnik/lib/pull/255#issuecomment-205045273), [systemd-nspawn](https://www.freedesktop.org/software/systemd/man/systemd-nspawn.html) or other containerization software can be used,
- **Only supported** compilation environment is [Ubuntu Xenial 16.04 x64](http://archive.ubuntu.com/ubuntu/dists/xenial-updates/main/installer-amd64/current/images/netboot/mini.iso) (**no other releases are supported**! It has to be exactly 16.04 otherwise default compiler versions might not match so if you're on an older Ubuntu release upgrade to 16.04 now, if you use a newer Ubuntu version start with 16.04 from scratch),
- installed basic system, OpenSSH and Samba (optional),
- no spaces in full path to the build script location allowed,
- superuser rights (configured `sudo` or root shell).

Please note that system requirements (both hardware and OS/software) may differ depending on the build environment (Vagrant, Docker, Virtualbox, native).

# How to start?

Login as root and run:

	apt-get -y -qq install git
	git clone --depth 1 https://github.com/armbian/build
	cd build

Run the script

	./compile.sh

Make sure that full path to the build script does not contain spaces.

![](http://www.armbian.com/wp-content/uploads/2016/01/21.png)

# Providing build configuration

After the first run of `compile.sh` a new configuration file `config-default.conf` will be created.
You may edit it to your needs or create different configuration files using it as a template.

Alternatively you can supply options as command line parameters to compile.sh
Example:

    ./compile.sh BOARD=cubietruck BRANCH=next KERNEL_ONLY=yes RELEASE=xenial

Note: Option `BUILD_ALL` cannot be set to "yes" via command line parameter.
ported site over to new repo, added tools, and quick documentation 2016-07-02 14:20:49 -04:00			`# What do I need?`

			`- x86/x64 machine running any OS; 4G ram, SSD, quad core (recommended),`
Update documentation 2016-08-09 20:18:19 +03:00			`- [VirtualBox](https://www.virtualbox.org/wiki/Downloads) or similar virtualization software (highly recommended with a minimum of 20GB hard disk space for the virtual disk image),`
Adjusted Vagrant readme path, no whitespace in path allowed 2017-09-14 11:16:11 +02:00			`- Setting up VirtualBox and compile environment is easy following our [Vagrant tutorial](https://docs.armbian.com/Developer-Guide_Using-Vagrant/),`
Clarify build requirements / options 2017-05-29 11:48:37 +02:00			- when you don't want to build whole OS images (`KERNEL_ONLY=yes`) then [Docker](https://github.com/igorpecovnik/lib/pull/255#issuecomment-205045273), [systemd-nspawn](https://www.freedesktop.org/software/systemd/man/systemd-nspawn.html) or other containerization software can be used,
			`- Only supported compilation environment is [Ubuntu Xenial 16.04 x64](http://archive.ubuntu.com/ubuntu/dists/xenial-updates/main/installer-amd64/current/images/netboot/mini.iso) (no other releases are supported! It has to be exactly 16.04 otherwise default compiler versions might not match so if you're on an older Ubuntu release upgrade to 16.04 now, if you use a newer Ubuntu version start with 16.04 from scratch),`
ported site over to new repo, added tools, and quick documentation 2016-07-02 14:20:49 -04:00			`- installed basic system, OpenSSH and Samba (optional),`
Adjusted Vagrant readme path, no whitespace in path allowed 2017-09-14 11:16:11 +02:00			`- no spaces in full path to the build script location allowed,`
Update documentation 2016-08-09 20:18:19 +03:00			- superuser rights (configured `sudo` or root shell).
ported site over to new repo, added tools, and quick documentation 2016-07-02 14:20:49 -04:00
initial docs update for the new directory structure 2017-08-01 12:37:25 +03:00			`Please note that system requirements (both hardware and OS/software) may differ depending on the build environment (Vagrant, Docker, Virtualbox, native).`

ported site over to new repo, added tools, and quick documentation 2016-07-02 14:20:49 -04:00			`# How to start?`

			`Login as root and run:`

			`apt-get -y -qq install git`
initial docs update for the new directory structure 2017-08-01 12:37:25 +03:00			`git clone --depth 1 https://github.com/armbian/build`
			`cd build`
ported site over to new repo, added tools, and quick documentation 2016-07-02 14:20:49 -04:00
			`Run the script`

			`./compile.sh`

No spaces in the build script path 2017-10-09 15:43:41 +03:00			`Make sure that full path to the build script does not contain spaces.`

ported site over to new repo, added tools, and quick documentation 2016-07-02 14:20:49 -04:00			`![](http://www.armbian.com/wp-content/uploads/2016/01/21.png)`

initial docs update for the new directory structure 2017-08-01 12:37:25 +03:00			`# Providing build configuration`

			After the first run of `compile.sh` a new configuration file `config-default.conf` will be created.
			`You may edit it to your needs or create different configuration files using it as a template.`

			`Alternatively you can supply options as command line parameters to compile.sh`
ported site over to new repo, added tools, and quick documentation 2016-07-02 14:20:49 -04:00			`Example:`

initial docs update for the new directory structure 2017-08-01 12:37:25 +03:00			`./compile.sh BOARD=cubietruck BRANCH=next KERNEL_ONLY=yes RELEASE=xenial`
ported site over to new repo, added tools, and quick documentation 2016-07-02 14:20:49 -04:00
			Note: Option `BUILD_ALL` cannot be set to "yes" via command line parameter.