diff options
Diffstat (limited to 'documentation/toaster-manual/toaster-manual-start.rst')
-rw-r--r-- | documentation/toaster-manual/toaster-manual-start.rst | 46 |
1 files changed, 46 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..54f290590b --- /dev/null +++ b/documentation/toaster-manual/toaster-manual-start.rst | |||
@@ -0,0 +1,46 @@ | |||
1 | ************************ | ||
2 | Preparing to Use Toaster | ||
3 | ************************ | ||
4 | |||
5 | This chapter describes how you need to prepare your system in order to | ||
6 | use Toaster. | ||
7 | |||
8 | .. _toaster-setting-up-the-basic-system-requirements: | ||
9 | |||
10 | Setting Up the Basic System Requirements | ||
11 | ======================================== | ||
12 | |||
13 | Before you can use Toaster, you need to first set up your build system | ||
14 | to run the Yocto Project. To do this, follow the instructions in the | ||
15 | "`Preparing the Build | ||
16 | Host <&YOCTO_DOCS_DEV_URL;#dev-preparing-the-build-host>`__" section of | ||
17 | the Yocto Project Development Tasks Manual. For Ubuntu/Debian, you might | ||
18 | also need to do an additional install of pip3. $ sudo apt-get install | ||
19 | python3-pip | ||
20 | |||
21 | .. _toaster-establishing-toaster-system-dependencies: | ||
22 | |||
23 | Establishing Toaster System Dependencies | ||
24 | ======================================== | ||
25 | |||
26 | Toaster requires extra Python dependencies in order to run. A Toaster | ||
27 | requirements file named ``toaster-requirements.txt`` defines the Python | ||
28 | dependencies. The requirements file is located in the ``bitbake`` | ||
29 | directory, which is located in the root directory of the `Source | ||
30 | Directory <&YOCTO_DOCS_REF_URL;#source-directory>`__ (e.g. | ||
31 | ``poky/bitbake/toaster-requirements.txt``). The dependencies appear in a | ||
32 | ``pip``, install-compatible format. | ||
33 | |||
34 | .. _toaster-load-packages: | ||
35 | |||
36 | Install Toaster Packages | ||
37 | ------------------------ | ||
38 | |||
39 | You need to install the packages that Toaster requires. Use this | ||
40 | command: $ pip3 install --user -r bitbake/toaster-requirements.txt The | ||
41 | previous command installs the necessary Toaster modules into a local | ||
42 | python 3 cache in your ``$HOME`` directory. The caches is actually | ||
43 | located in ``$HOME/.local``. To see what packages have been installed | ||
44 | into your ``$HOME`` directory, do the following: $ pip3 list installed | ||
45 | --local If you need to remove something, the following works: $ pip3 | ||
46 | uninstall PackageNameToUninstall | ||