blob: c5c6795f6582278453fba9cc6377db659da5106a [file] [log] [blame]
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4
5<chapter id='toaster-manual-start'>
6
7<title>Preparing to Use Toaster</title>
8
9 <para>
10 This chapter describes how you need to prepare your system in order to
11 use Toaster.
12 </para>
13
14 <section id='toaster-setting-up-the-basic-system-requirements'>
15 <title>Setting Up the Basic System Requirements</title>
16
17 <para>
Patrick Williamsf1e5d692016-03-30 15:21:19 -050018 Before you can use Toaster, you need to first set up your
19 build system to run the Yocto Project.
20 To do this, follow the instructions in the
21 "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Build Host Packages</ulink>"
22 and
23 "<ulink url='&YOCTO_DOCS_QS_URL;#releases'>Yocto Project Release</ulink>"
24 sections in the Yocto Project Quick Start.
Patrick Williamsc0f7c042017-02-23 20:41:17 -060025 For Ubuntu/Debian, you might also need to do an additional install
26 of pip3.
27 <literallayout class='monospaced'>
28 $ sudo apt-get install python3-pip
29 </literallayout>
Patrick Williamsc124f4f2015-09-15 14:41:29 -050030 </para>
31 </section>
32
33 <section id='toaster-establishing-toaster-system-dependencies'>
34 <title>Establishing Toaster System Dependencies</title>
35
36 <para>
37 Toaster requires extra Python dependencies in order to run.
38 A Toaster requirements file named
39 <filename>toaster-requirements.txt</filename> defines the
40 Python dependencies.
41 The requirements file is located in the
42 <filename>bitbake</filename> directory, which is located in the
43 root directory of the
44 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
45 (e.g. <filename>poky/bitbake/toaster-requirements.txt</filename>).
46 The dependencies appear in a <filename>pip</filename>,
47 install-compatible format.
48 </para>
49
Patrick Williamsc124f4f2015-09-15 14:41:29 -050050 <section id='toaster-load-packages'>
51 <title>Install Toaster Packages</title>
52
53 <para>
54 You need to install the packages that Toaster requires.
55 Use this command:
56 <literallayout class='monospaced'>
Patrick Williamsc0f7c042017-02-23 20:41:17 -060057 $ $ pip3 install --user -r bitbake/toaster-requirements.txt
58 </literallayout>
59 The previous command installs the necessary Toaster modules
60 into a local python 3 cache in your
61 <filename>$HOME</filename> directory.
62 The caches is actually located in
63 <filename>$HOME/.local</filename>.
64 To see what packages have been installed into your
65 <filename>$HOME</filename> directory, do the following:
66 <literallayout class='monospaced'>
67 $ pip3 list installed --local
68 </literallayout>
69 If you need to remove something, the following works:
70 <literallayout class='monospaced'>
71 $ pip3 uninstall PackageNameToUninstall
Patrick Williamsc124f4f2015-09-15 14:41:29 -050072 </literallayout>
73 </para>
74 </section>
75
76<!-- Commenting this section out for now in case it needs to be used again.
77
78 <section id='toaster-install-daemon'>
79 <title>Install <filename>daemon</filename></title>
80
81 <para>
82 Toaster depends on
83 <ulink url='http://www.libslack.org/daemon/'><filename>daemon</filename></ulink>.
84 Depending on your distribution, how you install
85 <filename>daemon</filename> differs:
86 <itemizedlist>
87 <listitem><para><emphasis>Debian-Based Systems:</emphasis>
88 If you are running a Debian-based distribution,
89 install <filename>daemon</filename> using the
90 following command:
91 <literallayout class='monospaced'>
92 $ sudo apt-get install daemon​
93 </literallayout>
94 </para></listitem>
95 <listitem><para><emphasis>Non-Debian-Based Systems:</emphasis>
96 If you are not running a Debian-based distribution
97 (Redhat-based distribution such as Fedora),
98 you need to download ​the file relevant to the
99 architecture and then install
100 <filename>daemon</filename> manually.
101 Following are the commands for 64-bit distributions:
102 <literallayout class='monospaced'>
103 $ wget http://libslack.org/daemon/download/daemon-0.6.4-1.x86_64.rpm
104 $ sudo rpm -i daemon-0.6.4-1.x86_64.rpm
105 </literallayout>
106 Here are the commands for a 32-bit distribution:
107 <literallayout class='monospaced'>
108 $ wget http://libslack.org/daemon/download/daemon-0.6.4-1.i686.rpm
109 $ sudo rpm -i ​daemon-0.6.4-1.i686.rpm​
110 </literallayout>
111 </para></listitem>
112 </itemizedlist>
113 </para>
114 </section> -->
115 </section>
116</chapter>