blob: fc187ecd5e83d083851572389c7462190a3f6b9d [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
Brad Bishop1a4b7ee2018-12-16 17:11:34 -080021 "<ulink url='&YOCTO_DOCS_DEV_URL;#dev-preparing-the-build-host'>Preparing the Build Host</ulink>"
Brad Bishop316dfdd2018-06-25 12:45:53 -040022 section of the Yocto Project Development Tasks
23 Manual.
Patrick Williamsc0f7c042017-02-23 20:41:17 -060024 For Ubuntu/Debian, you might also need to do an additional install
25 of pip3.
26 <literallayout class='monospaced'>
27 $ sudo apt-get install python3-pip
28 </literallayout>
Patrick Williamsc124f4f2015-09-15 14:41:29 -050029 </para>
30 </section>
31
32 <section id='toaster-establishing-toaster-system-dependencies'>
33 <title>Establishing Toaster System Dependencies</title>
34
35 <para>
36 Toaster requires extra Python dependencies in order to run.
37 A Toaster requirements file named
38 <filename>toaster-requirements.txt</filename> defines the
39 Python dependencies.
40 The requirements file is located in the
41 <filename>bitbake</filename> directory, which is located in the
42 root directory of the
Brad Bishopd7bf8c12018-02-25 22:55:05 -050043 <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>
Patrick Williamsc124f4f2015-09-15 14:41:29 -050044 (e.g. <filename>poky/bitbake/toaster-requirements.txt</filename>).
45 The dependencies appear in a <filename>pip</filename>,
46 install-compatible format.
47 </para>
48
Patrick Williamsc124f4f2015-09-15 14:41:29 -050049 <section id='toaster-load-packages'>
50 <title>Install Toaster Packages</title>
51
52 <para>
53 You need to install the packages that Toaster requires.
54 Use this command:
55 <literallayout class='monospaced'>
Brad Bishopd7bf8c12018-02-25 22:55:05 -050056 $ pip3 install --user -r bitbake/toaster-requirements.txt
Patrick Williamsc0f7c042017-02-23 20:41:17 -060057 </literallayout>
58 The previous command installs the necessary Toaster modules
59 into a local python 3 cache in your
60 <filename>$HOME</filename> directory.
61 The caches is actually located in
62 <filename>$HOME/.local</filename>.
63 To see what packages have been installed into your
64 <filename>$HOME</filename> directory, do the following:
65 <literallayout class='monospaced'>
66 $ pip3 list installed --local
67 </literallayout>
68 If you need to remove something, the following works:
69 <literallayout class='monospaced'>
70 $ pip3 uninstall PackageNameToUninstall
Patrick Williamsc124f4f2015-09-15 14:41:29 -050071 </literallayout>
72 </para>
73 </section>
74
75<!-- Commenting this section out for now in case it needs to be used again.
76
77 <section id='toaster-install-daemon'>
78 <title>Install <filename>daemon</filename></title>
79
80 <para>
81 Toaster depends on
82 <ulink url='http://www.libslack.org/daemon/'><filename>daemon</filename></ulink>.
83 Depending on your distribution, how you install
84 <filename>daemon</filename> differs:
85 <itemizedlist>
86 <listitem><para><emphasis>Debian-Based Systems:</emphasis>
87 If you are running a Debian-based distribution,
88 install <filename>daemon</filename> using the
89 following command:
90 <literallayout class='monospaced'>
91 $ sudo apt-get install daemon​
92 </literallayout>
93 </para></listitem>
94 <listitem><para><emphasis>Non-Debian-Based Systems:</emphasis>
95 If you are not running a Debian-based distribution
96 (Redhat-based distribution such as Fedora),
97 you need to download ​the file relevant to the
98 architecture and then install
99 <filename>daemon</filename> manually.
100 Following are the commands for 64-bit distributions:
101 <literallayout class='monospaced'>
102 $ wget http://libslack.org/daemon/download/daemon-0.6.4-1.x86_64.rpm
103 $ sudo rpm -i daemon-0.6.4-1.x86_64.rpm
104 </literallayout>
105 Here are the commands for a 32-bit distribution:
106 <literallayout class='monospaced'>
107 $ wget http://libslack.org/daemon/download/daemon-0.6.4-1.i686.rpm
108 $ sudo rpm -i ​daemon-0.6.4-1.i686.rpm​
109 </literallayout>
110 </para></listitem>
111 </itemizedlist>
112 </para>
113 </section> -->
114 </section>
115</chapter>