diff --git a/doc/source/installation.rst b/doc/source/installation.rst index 98e5d0a2..51b10cb0 100644 --- a/doc/source/installation.rst +++ b/doc/source/installation.rst @@ -15,16 +15,23 @@ Operating System WA runs on a native Linux install. It was tested with Ubuntu 12.04, but any recent Linux distribution should work. It should run on either -32bit or 64bit OS, provided the correct version of Android (see below) +32-bit or 64-bit OS, provided the correct version of Android (see below) was installed. Officially, **other environments are not supported**. WA has been known to run on Linux Virtual machines and in Cygwin environments, -though additional configuration maybe required in both cases (known issues +though additional configuration may be required in both cases (known issues include makings sure USB/serial connections are passed to the VM, and wrong python/pip binaries being picked up in Cygwin). WA *should* work on other Unix-based systems such as BSD or Mac OS X, but it has not been tested in those environments. WA *does not* run on Windows (though it should be possible to get limited functionality with minimal porting effort). +.. Note:: If you plan to run Workload Automation on Linux devices only, + SSH is required, and Android SDK is optional if you wish + to run WA on Android devices at a later time. Then follow the + steps to install the necessary python packages to set up WA. + + However, you would be starting off with a limited number of + workloads that will run on Linux devices. Android SDK ----------- @@ -32,8 +39,8 @@ Android SDK You need to have the Android SDK with at least one platform installed. To install it, download the ADT Bundle from here_. Extract it and add ``/sdk/platform-tools`` and ``/sdk/tools`` -to your ``PATH``. To test that you've installed it properly run ``adb -version``, the output should be similar to this:: +to your ``PATH``. To test that you've installed it properly, run ``adb +version``. The output should be similar to this:: $$ adb version Android Debug Bridge version 1.0.31 @@ -57,7 +64,7 @@ the install location of the SDK (i.e. ``/sdk``). Python ------ -Workload Automation 2 requires Python 2.7 (Python 3 is not supported, at the moment). +Workload Automation 2 requires Python 2.7 (Python 3 is not supported at the moment). pip @@ -133,6 +140,10 @@ may not always have Internet access). Installing ========== +.. 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. + Download the tarball and run pip:: sudo pip install wlauto-$version.tar.gz diff --git a/doc/source/quickstart.rst b/doc/source/quickstart.rst index 4f88146c..038ae1c4 100644 --- a/doc/source/quickstart.rst +++ b/doc/source/quickstart.rst @@ -13,17 +13,20 @@ Install the :doc:`installation` section. Make sure you have Python 2.7 and a recent Android SDK with API level 18 or above -installed on your system. For the SDK, make sure that either ``ANDROID_HOME`` -environment variable is set, or that ``adb`` is in your ``PATH``. +installed on your system. A complete install of the Android SDK is required, as +WA uses a number of its utilities, not just adb. For the SDK, make sure that either +``ANDROID_HOME`` environment variable is set, or that ``adb`` is in your ``PATH``. -.. note:: A complete install of the Android SDK is required, as WA uses a - number of its utilities, not just adb. +.. Note:: If you plan to run Workload Automation on Linux devices only, SSH is required, + and Android SDK is optional if you wish to run WA on Android devices at a + later time. + + However, you would be starting off with a limited number of workloads that + will run on Linux devices. 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. -.. note:: For Linux, SSH is also required. - Once you have the prerequisites and a tarball with the workload automation package, you can install it with pip:: @@ -31,9 +34,9 @@ you can install it with pip:: Where $version is the current version of WA. -.. 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. +.. 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.