Generic updates to the documentation matching master and koi
[AGL/documentation.git] / docs / 0_Getting_Started / 2_Building_AGL_Image / 1_Preparing_Your_Build_Host.md
1 ---
2 title: Preparing Your Build Host
3 ---
4
5 Preparing your build host so that it can build an AGL image means
6 making sure your system is set up to use the
7 [Yocto Project](https://yoctoproject.org) OpenEmbedded build system,
8 which is based on
9 [BitBake](https://yoctoproject.org/docs/3.1.4/bitbake-user-manual/bitbake-user-manual.html).
10
11 This section presents minimal information so you can prepare the build host
12 to use the "Dunfell" version of the Yocto Project (i.e. version 3.1.2).
13 If you want more details on how the Yocto Project works, you can reference
14 the Yocto Project documentation
15 [here](https://www.yoctoproject.org/docs/).
16
17 **NOTE:** This entire section presumes you want to build an image.
18 You can skip the entire build process if you want to use a ready-made
19 development image.
20 The [supported images](https://download.automotivelinux.org/AGL/snapshots/master/latest/) exist for several boards as
21 well as for the Quick EMUlator (QEMU).
22 See the
23 "[Quickstart](../1_Quickstart/Using_Ready_Made_Images.md)"
24 section for more information on the ready-made images.
25
26 1. **Use a Supported Linux Distribution:** To use the AGL software, it is
27    recommended that your build host is a native Linux machine that runs a
28    Yocto Project supported distribution as described by the
29    "[Supported Linux Distributions](https://www.yoctoproject.org/docs/3.1.4/ref-manual/ref-manual.html#detailed-supported-distros)"
30    section in the Yocto Project Reference Manual.
31    Basically, you should be running a recent version of Ubuntu, Fedora, openSUSE,
32    CentOS, or Debian.
33
34 2. **Be Sure Your Build Host Has Enough Free Disk Space:**
35    Your build host should have at least 100 Gbytes.
36
37 3. **Be Sure Tools are Recent:**  You need to have recent versions for
38    the following tools:
39
40    * Git 1.8.3.1 or greater
41    * Tar 1.27 or greater
42    * Python 3.4.0 or greater
43
44    If your distribution does not meet these minimal requirements, see the
45    "[Required Git, tar, and Python Versions](https://www.yoctoproject.org/docs/3.1.4/ref-manual/ref-manual.html#required-git-tar-and-python-versions)"
46    section in the Yocto Project Reference Manual for steps that you can
47    take to be sure you have these tools.
48
49 4. **Install Essential, Graphical, and Eclipse Plug-in Build Host Packages:**
50    Your build host needs certain host packages.
51    Depending on the Linux distribution you are using, the list of
52    host packages differ.
53    See
54    "[The Build Host Packages](https://www.yoctoproject.org/docs/3.1.4/yocto-project-qs/yocto-project-qs.html#packages)"
55    section of the Yocto Project Quick Start for information on the packages you need.
56
57    **NOTE:** If you are using the CentOS distribution, you need to
58    separately install the epel-release package and run the `makecache` command as
59    described in
60    "[The Build Host Packages](https://www.yoctoproject.org/docs/3.1.4/yocto-project-qs/yocto-project-qs.html#packages)"
61    section of the Yocto Project Quick Start.
62
63    Aside from the packages listed in the previous section, you need the following:
64
65    * **Ubuntu and Debian:** curl
66    * **Fedora:** curl
67    * **OpenSUSE:** glibc-locale curl
68    * **CentOS:** curl