From 0a42f24590faeb09ef197f77796050a355c605ce Mon Sep 17 00:00:00 2001 From: Marc Bonnici Date: Fri, 6 Jul 2018 15:20:49 +0100 Subject: [PATCH] README: Update with WA3 Information --- README.rst | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/README.rst b/README.rst index b3bf56db..a9b1ecd0 100644 --- a/README.rst +++ b/README.rst @@ -2,23 +2,23 @@ Workload Automation +++++++++++++++++++ Workload Automation (WA) is a framework for executing workloads and collecting -measurements on Android and Linux devices. WA includes automation for nearly 50 -workloads (mostly Android), some common instrumentation (ftrace, ARM -Streamline, hwmon). A number of output formats are supported. +measurements on Android and Linux devices. WA includes automation for nearly 40 +workloads and supports some common instrumentation (ftrace, hwmon) along with a +number of output formats. -Workload Automation is designed primarily as a developer tool/framework to -facilitate data driven development by providing a method of collecting -measurements from a device in a repeatable way. +WA is designed primarily as a developer tool/framework to facilitate data driven +development by providing a method of collecting measurements from a device in a +repeatable way. -Workload Automation is highly extensible. Most of the concrete functionality is -implemented via plug-ins, and it is easy to write new plug-ins to support new -device types, workloads, instrumentation or output processing. +WA is highly extensible. Most of the concrete functionality is implemented via +plug-ins, and it is easy to write new plug-ins to support new device types, +workloads, instruments or output processing. Requirements ============ -- Python 2.7 +- Python 2.7 or Python 3 - Linux (should work on other Unixes, but untested) - Latest Android SDK (ANDROID_HOME must be set) for Android devices, or - SSH for Linux devices @@ -29,24 +29,24 @@ Installation To install:: - python setup.py sdist - sudo pip install dist/wlauto-*.tar.gz + git clone git@github.com:ARM-software/workload-automation.git workload-automation + sudo -H pip install ./workload-automation -Please refer to the `installation section <./doc/source/installation.rst>`_ +Please refer to the `installation section `_ in the documentation for more details. Basic Usage =========== -Please see the `Quickstart <./doc/source/quickstart.rst>`_ section of the -documentation. +Please see the `Quickstart `_ +section of the documentation. Documentation ============= -You can view pre-built HTML documentation `here `_. +You can view pre-built HTML documentation `here `_. Documentation in reStructuredText format may be found under ``doc/source``. To compile it into cross-linked HTML, make sure you have `Sphinx @@ -61,11 +61,11 @@ License Workload Automation is distributed under `Apache v2.0 License `_. Workload automation includes -binaries distributed under differnt licenses (see LICENSE files in specfic +binaries distributed under different licenses (see LICENSE files in specific directories). -Feedback, Contrubutions and Support +Feedback, Contributions and Support =================================== - Please use the GitHub Issue Tracker associated with this repository for