blob: c687a82531c7e3f18bd5b60c0a09cfeefaf0ebbf [file] [log] [blame]
Andrew Geisslerf0343792020-11-18 10:42:21 -06001.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
Andrew Geisslerc9f78652020-09-18 14:11:35 -05002.. Set default pygments highlighting to shell for this document
3.. highlight:: shell
4
5************************
6Preparing to Use Toaster
7************************
8
9This chapter describes how you need to prepare your system in order to
10use Toaster.
11
Andrew Geisslerc9f78652020-09-18 14:11:35 -050012Setting Up the Basic System Requirements
13========================================
14
15Before you can use Toaster, you need to first set up your build system
16to run the Yocto Project. To do this, follow the instructions in the
Andrew Geissler09209ee2020-12-13 08:44:15 -060017":ref:`dev-manual/start:preparing the build host`" section of
Andrew Geisslerc9f78652020-09-18 14:11:35 -050018the Yocto Project Development Tasks Manual. For Ubuntu/Debian, you might
19also need to do an additional install of pip3. ::
20
21 $ sudo apt-get install python3-pip
22
Andrew Geisslerc9f78652020-09-18 14:11:35 -050023Establishing Toaster System Dependencies
24========================================
25
26Toaster requires extra Python dependencies in order to run. A Toaster
27requirements file named ``toaster-requirements.txt`` defines the Python
28dependencies. The requirements file is located in the ``bitbake``
29directory, which is located in the root directory of the
30:term:`Source Directory` (e.g.
31``poky/bitbake/toaster-requirements.txt``). The dependencies appear in a
32``pip``, install-compatible format.
33
Andrew Geisslerc9f78652020-09-18 14:11:35 -050034Install Toaster Packages
35------------------------
36
37You need to install the packages that Toaster requires. Use this
38command::
39
40 $ pip3 install --user -r bitbake/toaster-requirements.txt
41
42The previous command installs the necessary Toaster modules into a local
43python 3 cache in your ``$HOME`` directory. The caches is actually
44located in ``$HOME/.local``. To see what packages have been installed
45into your ``$HOME`` directory, do the following::
46
47 $ pip3 list installed --local
48
49If you need to remove something, the following works::
50
51 $ pip3 uninstall PackageNameToUninstall