diff options
Diffstat (limited to 'documentation/toaster-manual/toaster-manual-start.xml')
| -rw-r--r-- | documentation/toaster-manual/toaster-manual-start.xml | 71 |
1 files changed, 20 insertions, 51 deletions
diff --git a/documentation/toaster-manual/toaster-manual-start.xml b/documentation/toaster-manual/toaster-manual-start.xml index daefa79090..c5c6795f65 100644 --- a/documentation/toaster-manual/toaster-manual-start.xml +++ b/documentation/toaster-manual/toaster-manual-start.xml | |||
| @@ -22,6 +22,11 @@ | |||
| 22 | and | 22 | and |
| 23 | "<ulink url='&YOCTO_DOCS_QS_URL;#releases'>Yocto Project Release</ulink>" | 23 | "<ulink url='&YOCTO_DOCS_QS_URL;#releases'>Yocto Project Release</ulink>" |
| 24 | sections in the Yocto Project Quick Start. | 24 | sections in the Yocto Project Quick Start. |
| 25 | 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> | ||
| 25 | </para> | 30 | </para> |
| 26 | </section> | 31 | </section> |
| 27 | 32 | ||
| @@ -42,56 +47,6 @@ | |||
| 42 | install-compatible format. | 47 | install-compatible format. |
| 43 | </para> | 48 | </para> |
| 44 | 49 | ||
| 45 | <section id='toaster-virtual-environment'> | ||
| 46 | <title>Set Up a Python Virtual Environment</title> | ||
| 47 | |||
| 48 | <para> | ||
| 49 | Set up a Python virtual environment that allows you | ||
| 50 | to maintain a dedicated Python executable and its own | ||
| 51 | set of installed modules. | ||
| 52 | Doing so separates the executable from Python and the | ||
| 53 | modules provided by the operating system. | ||
| 54 | This separation avoids any version conflicts. | ||
| 55 | <note> | ||
| 56 | Creating a virtual environment is not absolutely | ||
| 57 | necessary. | ||
| 58 | However, doing so is highly recommended. | ||
| 59 | </note> | ||
| 60 | </para> | ||
| 61 | |||
| 62 | <para> | ||
| 63 | Follow these steps to set up your virtual environment. | ||
| 64 | These steps assume a Ubuntu distribution: | ||
| 65 | <orderedlist> | ||
| 66 | <listitem><para><emphasis>Install <filename>virtualenv</filename>:</emphasis> | ||
| 67 | Install the supported | ||
| 68 | <filename>python-virtualenv</filename> package from your | ||
| 69 | distribution rather than using <filename>pip</filename>. | ||
| 70 | <literallayout class='monospaced'> | ||
| 71 | $ sudo apt-get install python-virtualenv | ||
| 72 | </literallayout> | ||
| 73 | </para></listitem> | ||
| 74 | <listitem><para><emphasis>Create and Activate a Virtual Environment:</emphasis> | ||
| 75 | <literallayout class='monospaced'> | ||
| 76 | $ virtualenv venv | ||
| 77 | $ source venv/bin/activate | ||
| 78 | </literallayout> | ||
| 79 | </para></listitem> | ||
| 80 | </orderedlist> | ||
| 81 | <note> | ||
| 82 | After setting up a virtual environment in | ||
| 83 | which to run Toaster, you must initialize that | ||
| 84 | virtual environment each time you want to start | ||
| 85 | Toaster. | ||
| 86 | Use the following to initialize the environment just | ||
| 87 | before you start Toaster: | ||
| 88 | <literallayout class='monospaced'> | ||
| 89 | $ source venv/bin/activate | ||
| 90 | </literallayout> | ||
| 91 | </note> | ||
| 92 | </para> | ||
| 93 | </section> | ||
| 94 | |||
| 95 | <section id='toaster-load-packages'> | 50 | <section id='toaster-load-packages'> |
| 96 | <title>Install Toaster Packages</title> | 51 | <title>Install Toaster Packages</title> |
| 97 | 52 | ||
| @@ -99,7 +54,21 @@ | |||
| 99 | You need to install the packages that Toaster requires. | 54 | You need to install the packages that Toaster requires. |
| 100 | Use this command: | 55 | Use this command: |
| 101 | <literallayout class='monospaced'> | 56 | <literallayout class='monospaced'> |
| 102 | $ pip install -r bitbake/toaster-requirements.txt | 57 | $ $ 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 | ||
| 103 | </literallayout> | 72 | </literallayout> |
| 104 | </para> | 73 | </para> |
| 105 | </section> | 74 | </section> |
