sascha/workload-automation
1
0
Fork 0
mirror of https://github.com/ARM-software/workload-automation.git synced 2025-04-13 14:20:50 +01:00
Code Issues Releases Wiki Activity

doc: updating installation instructions

Browse Source 
Re-writing some of the instructions for clarity plus updating with the
correct pip invocations.
This commit is contained in:
Sergei Trofimov 2015-11-23 15:47:27 +00:00
parent 3453fe5fc1
commit b04d141680
2 changed files with 29 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
doc/source/installation.rst
View File

@ -42,9 +42,8 @@ and add ``<path_to_android_sdk>/sdk/platform-tools`` and ``<path_to_android_sdk>
to your ``PATH``. To test that you've installed it properly, run ``adb to your ``PATH``. To test that you've installed it properly, run ``adb
version``. The output should be similar to this:: version``. The output should be similar to this::
$$ adb version adb version
Android Debug Bridge version 1.0.31 Android Debug Bridge version 1.0.31
$$
.. _here: https://developer.android.com/sdk/index.html .. _here: https://developer.android.com/sdk/index.html
@ -82,8 +81,8 @@ similar distributions, this may be done with APT::
is recommended that you update pip and setuptools before proceeding is recommended that you update pip and setuptools before proceeding
with installation:: with installation::
sudo pip install --upgrade pip sudo -H pip install --upgrade pip
sudo pip install --upgrade setuptools sudo -H pip install --upgrade setuptools
If you do run into this issue after already installing some packages, If you do run into this issue after already installing some packages,
you can resolve it by running :: you can resolve it by running ::
@ -110,11 +109,11 @@ Workload Automation 2 depends on the following additional libraries:
You can install these with pip:: You can install these with pip::
sudo pip install pexpect sudo -H pip install pexpect
sudo pip install pyserial sudo -H pip install pyserial
sudo pip install pyyaml sudo -H pip install pyyaml
sudo pip install docutils sudo -H pip install docutils
sudo pip install python-dateutil sudo -H pip install python-dateutil
Some of these may also be available in your distro's repositories, e.g. :: Some of these may also be available in your distro's repositories, e.g. ::
@ -157,13 +156,22 @@ may not always have Internet access).
Installing Installing
========== ==========
.. note:: If you downloaded the Workload Automation source code from GitHub, open Installing the latest released version from PyPI (Python Package Index)::
the README.rst file to start the setup process. A wlauto tarball will
be created under the dist directory once the process is complete. sudo -H pip install wlauto
This will install WA along with its mandatory dependencies. If you would like to
install all optional dependencies at the same time, do the following instead::
sudo -H pip install wlauto[all]
Alternatively, you can also install the latest development version from GitHub
(you will need git installed for this to work)::
git clone git@github.com:ARM-software/workload-automation.git workload-automation
sudo -H pip install ./workload-automation
Download the tarball and run pip::
sudo pip install wlauto-$version.tar.gz
If the above succeeds, try :: If the above succeeds, try ::
@ -300,13 +308,14 @@ that location.
If you have installed Workload Automation via ``pip`` and wish to remove it, run this command to If you have installed Workload Automation via ``pip`` and wish to remove it, run this command to
uninstall it:: uninstall it::
sudo pip uninstall wlauto sudo -H pip uninstall wlauto
.. Note:: This will *not* remove any user configuration (e.g. the ~/.workload_automation directory) .. Note:: This will *not* remove any user configuration (e.g. the ~/.workload_automation directory)
(Optional) Upgrading (Optional) Upgrading
==================== ====================
To upgrade Workload Automation to the latest version via ``pip``, run:: To upgrade Workload Automation to the latest version via ``pip``, run::
sudo pip install --upgrade --no-deps wlauto sudo -H pip install --upgrade --no-deps wlauto

14
doc/source/quickstart.rst
View File

@ -27,18 +27,12 @@ WA uses a number of its utilities, not just adb. For the SDK, make sure that eit
In addition to the base Python 2.7 install, you will also need to have ``pip`` In addition to the base Python 2.7 install, you will also need to have ``pip``
(Python's package manager) installed as well. This is usually a separate package. (Python's package manager) installed as well. This is usually a separate package.
Once you have the prerequisites and a tarball with the workload automation package, Once you have those, you can install WA with::
you can install it with pip::
sudo pip install wlauto-$versiondev.tar.gz sudo -H pip install wlauto
Where $version is the current version of WA. This will install Workload Automation on your system, along with its mandatory
dependencies.
.. note:: If you downloaded the Workload Automation source code from GitHub, open the
README.rst file to start the setup process. A wlauto tarball will be created
under the dist directory once the process is complete.
This will install Workload Automation on your system, along with other dependencies.
(Optional) Verify installation (Optional) Verify installation
------------------------------- -------------------------------