summaryrefslogtreecommitdiffstats
path: root/documentation/toaster-manual/start.rst
diff options
context:
space:
mode:
authorNicolas Dechesne <nicolas.dechesne@linaro.org>2020-12-03 22:38:37 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-12-09 12:21:27 +0000
commitc684a7a6d50754d577e0ff68a6fb6ed493b8f93e (patch)
tree7af73c545d6a28d12645a60e85c2b184283f41b3 /documentation/toaster-manual/start.rst
parent9e35603c1244777e278f57c9634d1a5727cf799f (diff)
downloadpoky-c684a7a6d50754d577e0ff68a6fb6ed493b8f93e.tar.gz
toaster-manual: remove 'toaster-manual' from filenames
All filenames duplicate the 'manual name', which is not needed, and make all references longer than they should. Rename all files to be as consise as possible, and fix all references (From yocto-docs rev: b5a1a504caf7ffcaeca787b38bf7f11e341dfb0f) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/toaster-manual/start.rst')
-rw-r--r--documentation/toaster-manual/start.rst51
1 files changed, 51 insertions, 0 deletions
diff --git a/documentation/toaster-manual/start.rst b/documentation/toaster-manual/start.rst
new file mode 100644
index 0000000000..8883374164
--- /dev/null
+++ b/documentation/toaster-manual/start.rst
@@ -0,0 +1,51 @@
1.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
2.. 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
12Setting 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
17":ref:`dev-manual/dev-manual-start:preparing the build host`" section of
18the 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
23Establishing 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
34Install 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