diff options
Diffstat (limited to 'documentation/toaster-manual/toaster-manual-start.rst')
-rw-r--r-- | documentation/toaster-manual/toaster-manual-start.rst | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/documentation/toaster-manual/toaster-manual-start.rst b/documentation/toaster-manual/toaster-manual-start.rst new file mode 100644 index 0000000000..2d612b8938 --- /dev/null +++ b/documentation/toaster-manual/toaster-manual-start.rst | |||
@@ -0,0 +1,57 @@ | |||
1 | .. SPDX-License-Identifier: CC-BY-2.0-UK | ||
2 | .. Set default pygments highlighting to shell for this document | ||
3 | .. highlight:: shell | ||
4 | |||
5 | ************************ | ||
6 | Preparing to Use Toaster | ||
7 | ************************ | ||
8 | |||
9 | This chapter describes how you need to prepare your system in order to | ||
10 | use Toaster. | ||
11 | |||
12 | .. _toaster-setting-up-the-basic-system-requirements: | ||
13 | |||
14 | Setting Up the Basic System Requirements | ||
15 | ======================================== | ||
16 | |||
17 | Before you can use Toaster, you need to first set up your build system | ||
18 | to run the Yocto Project. To do this, follow the instructions in the | ||
19 | ":ref:`dev-manual/dev-manual-start:preparing the build host`" section of | ||
20 | the Yocto Project Development Tasks Manual. For Ubuntu/Debian, you might | ||
21 | also need to do an additional install of pip3. :: | ||
22 | |||
23 | $ sudo apt-get install python3-pip | ||
24 | |||
25 | .. _toaster-establishing-toaster-system-dependencies: | ||
26 | |||
27 | Establishing Toaster System Dependencies | ||
28 | ======================================== | ||
29 | |||
30 | Toaster requires extra Python dependencies in order to run. A Toaster | ||
31 | requirements file named ``toaster-requirements.txt`` defines the Python | ||
32 | dependencies. The requirements file is located in the ``bitbake`` | ||
33 | directory, which is located in the root directory of the | ||
34 | :term:`Source Directory` (e.g. | ||
35 | ``poky/bitbake/toaster-requirements.txt``). The dependencies appear in a | ||
36 | ``pip``, install-compatible format. | ||
37 | |||
38 | .. _toaster-load-packages: | ||
39 | |||
40 | Install Toaster Packages | ||
41 | ------------------------ | ||
42 | |||
43 | You need to install the packages that Toaster requires. Use this | ||
44 | command:: | ||
45 | |||
46 | $ pip3 install --user -r bitbake/toaster-requirements.txt | ||
47 | |||
48 | The previous command installs the necessary Toaster modules into a local | ||
49 | python 3 cache in your ``$HOME`` directory. The caches is actually | ||
50 | located in ``$HOME/.local``. To see what packages have been installed | ||
51 | into your ``$HOME`` directory, do the following:: | ||
52 | |||
53 | $ pip3 list installed --local | ||
54 | |||
55 | If you need to remove something, the following works:: | ||
56 | |||
57 | $ pip3 uninstall PackageNameToUninstall | ||