poky/documentation/toaster-manual/toaster-manual-start.rst
Nicolas Dechesne 424567d629 sphinx: manual updates for some links
Some links were not found by the regexp, especially because of they
are spanning across multiple lines. This patch is a manual fixup for
these patterns.

(From yocto-docs rev: 7a5cf8b372903d959d4a1f0882e6198f31f3cba5)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:33 +01:00

49 lines
1.8 KiB
ReStructuredText

.. SPDX-License-Identifier: CC-BY-2.0-UK
************************
Preparing to Use Toaster
************************
This chapter describes how you need to prepare your system in order to
use Toaster.
.. _toaster-setting-up-the-basic-system-requirements:
Setting Up the Basic System Requirements
========================================
Before you can use Toaster, you need to first set up your build system
to run the Yocto Project. To do this, follow the instructions in the
"`Preparing the Build
Host <&YOCTO_DOCS_DEV_URL;#dev-preparing-the-build-host>`__" section of
the Yocto Project Development Tasks Manual. For Ubuntu/Debian, you might
also need to do an additional install of pip3. $ sudo apt-get install
python3-pip
.. _toaster-establishing-toaster-system-dependencies:
Establishing Toaster System Dependencies
========================================
Toaster requires extra Python dependencies in order to run. A Toaster
requirements file named ``toaster-requirements.txt`` defines the Python
dependencies. The requirements file is located in the ``bitbake``
directory, which is located in the root directory of the
:term:`Source Directory` (e.g.
``poky/bitbake/toaster-requirements.txt``). The dependencies appear in a
``pip``, install-compatible format.
.. _toaster-load-packages:
Install Toaster Packages
------------------------
You need to install the packages that Toaster requires. Use this
command: $ pip3 install --user -r bitbake/toaster-requirements.txt The
previous command installs the necessary Toaster modules into a local
python 3 cache in your ``$HOME`` directory. The caches is actually
located in ``$HOME/.local``. To see what packages have been installed
into your ``$HOME`` directory, do the following: $ pip3 list installed
--local If you need to remove something, the following works: $ pip3
uninstall PackageNameToUninstall