diff options
Diffstat (limited to 'documentation/toaster-manual/toaster-manual-start.xml')
-rw-r--r-- | documentation/toaster-manual/toaster-manual-start.xml | 75 |
1 files changed, 75 insertions, 0 deletions
diff --git a/documentation/toaster-manual/toaster-manual-start.xml b/documentation/toaster-manual/toaster-manual-start.xml new file mode 100644 index 0000000000..93f48c7b26 --- /dev/null +++ b/documentation/toaster-manual/toaster-manual-start.xml | |||
@@ -0,0 +1,75 @@ | |||
1 | <!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 | Toaster requires some packages that you must have installed before trying | ||
13 | to run Toaster. | ||
14 | </para> | ||
15 | |||
16 | <section id='toaster-setting-up-the-basic-system-requirements'> | ||
17 | <title>Setting Up the Basic System Requirements</title> | ||
18 | |||
19 | <para> | ||
20 | You first need to be sure your build system is set up to run | ||
21 | the Yocto Project. | ||
22 | See the | ||
23 | "<ulink url='&YOCTO_DOCS_QS_URL;#yp-resources'>What You Need and How You Get It</ulink>" | ||
24 | section in the Yocto Project Quick Start for information on how | ||
25 | to set up your system for the Yocto Project. | ||
26 | </para> | ||
27 | </section> | ||
28 | |||
29 | <section id='toaster-establishing-toaster-system-dependencies'> | ||
30 | <title>Establishing Toaster System Dependencies</title> | ||
31 | |||
32 | <para> | ||
33 | Toaster requires extra Python dependencies that Bitbake | ||
34 | does not need in order to run. | ||
35 | In order to make it easy to run Toaster, a requirements file | ||
36 | located in the root directory of | ||
37 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> | ||
38 | <filename>bitbake/</filename> | ||
39 | (e.g. <filename>poky/bitbake/toaster-requirements.txt</filename>). | ||
40 | The dependencies appear in a <filename>pip</filename>, | ||
41 | install-compatible format: | ||
42 | <literallayout class='monospaced'> | ||
43 | Django==1.6 | ||
44 | South==0.8.4 | ||
45 | argparse==1.2.1 | ||
46 | wsgiref==0.1.2 | ||
47 | </literallayout> | ||
48 | Follow these steps to get set up: | ||
49 | <orderedlist> | ||
50 | <listitem><para><emphasis>Create and activate a virtual environment:</emphasis> | ||
51 | <literallayout class='monospaced'> | ||
52 | $ virtualenv venv | ||
53 | $ source venv/bin/activate | ||
54 | </literallayout> | ||
55 | </para></listitem> | ||
56 | <listitem><para><emphasis>Use <filename>pip</filename> to install needed packages:</emphasis> | ||
57 | <literallayout class='monospaced'> | ||
58 | $ pip install -r bitbake/toaster-requirements.txt | ||
59 | </literallayout> | ||
60 | </para></listitem> | ||
61 | </orderedlist> | ||
62 | Once you complete these steps, you execute in a lightweight | ||
63 | "virtual environment” with its own site directories that are | ||
64 | optionally isolated from system site directories. | ||
65 | The virtual environment has its own Python binary | ||
66 | (allowing creation of environments with various Python versions) | ||
67 | and can have its own independent set of installed Python packages | ||
68 | in its site directories. | ||
69 | </para> | ||
70 | </section> | ||
71 | |||
72 | </chapter> | ||
73 | <!-- | ||
74 | vim: expandtab tw=80 ts=4 | ||
75 | --> | ||