mirror of
				https://github.com/ARM-software/workload-automation.git
				synced 2025-11-04 00:52:08 +00:00 
			
		
		
		
	README: Update with WA3 Information
This commit is contained in:
		
							
								
								
									
										36
									
								
								README.rst
									
									
									
									
									
								
							
							
						
						
									
										36
									
								
								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 <http://workload-automation.readthedocs.io/en/latest/user_information.html#install>`_
 | 
			
		||||
in the documentation for more details.
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
Basic Usage
 | 
			
		||||
===========
 | 
			
		||||
 | 
			
		||||
Please see the `Quickstart <./doc/source/quickstart.rst>`_ section of the 
 | 
			
		||||
documentation.
 | 
			
		||||
Please see the `Quickstart <http://workload-automation.readthedocs.io/en/latest/user_information.html#user-guide>`_
 | 
			
		||||
section of the documentation.
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
Documentation
 | 
			
		||||
=============
 | 
			
		||||
 | 
			
		||||
You can view pre-built HTML documentation `here <http://pythonhosted.org/wlauto/>`_.
 | 
			
		||||
You can view pre-built HTML documentation `here <http://workload-automation.readthedocs.io/en/latest/>`_.
 | 
			
		||||
 | 
			
		||||
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
 | 
			
		||||
<http://www.apache.org/licenses/LICENSE-2.0>`_. 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
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user