mirror of
				https://github.com/ARM-software/workload-automation.git
				synced 2025-11-04 09:02:12 +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
 | 
					Workload Automation (WA) is a framework for executing workloads and collecting
 | 
				
			||||||
measurements on Android and Linux devices. WA includes automation for nearly 50
 | 
					measurements on Android and Linux devices. WA includes automation for nearly 40
 | 
				
			||||||
workloads (mostly Android), some common instrumentation (ftrace, ARM
 | 
					workloads and supports some common instrumentation (ftrace, hwmon) along with a
 | 
				
			||||||
Streamline, hwmon).  A number of output formats are supported. 
 | 
					number of output formats.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Workload Automation is designed primarily as a developer tool/framework to
 | 
					WA is designed primarily as a developer tool/framework to facilitate data driven
 | 
				
			||||||
facilitate data driven development by providing a method of collecting
 | 
					development by providing a method of collecting measurements from a device in a
 | 
				
			||||||
measurements from a device in a repeatable way.
 | 
					repeatable way.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Workload Automation is highly extensible. Most of the concrete functionality is
 | 
					WA is highly extensible. Most of the concrete functionality is implemented via
 | 
				
			||||||
implemented via plug-ins, and  it is easy to write new plug-ins to support new
 | 
					plug-ins, and it is easy to write new plug-ins to support new device types,
 | 
				
			||||||
device types, workloads, instrumentation or output processing. 
 | 
					workloads, instruments or output processing.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Requirements
 | 
					Requirements
 | 
				
			||||||
============
 | 
					============
 | 
				
			||||||
 | 
					
 | 
				
			||||||
- Python 2.7
 | 
					- Python 2.7 or Python 3
 | 
				
			||||||
- Linux (should work on other Unixes, but untested)
 | 
					- Linux (should work on other Unixes, but untested)
 | 
				
			||||||
- Latest Android SDK (ANDROID_HOME must be set) for Android devices, or
 | 
					- Latest Android SDK (ANDROID_HOME must be set) for Android devices, or
 | 
				
			||||||
- SSH for Linux devices
 | 
					- SSH for Linux devices
 | 
				
			||||||
@@ -29,24 +29,24 @@ Installation
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
To install::
 | 
					To install::
 | 
				
			||||||
 | 
					
 | 
				
			||||||
        python setup.py sdist
 | 
					        git clone git@github.com:ARM-software/workload-automation.git workload-automation
 | 
				
			||||||
        sudo pip install dist/wlauto-*.tar.gz
 | 
					        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.
 | 
					in the documentation for more details.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Basic Usage
 | 
					Basic Usage
 | 
				
			||||||
===========
 | 
					===========
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Please see the `Quickstart <./doc/source/quickstart.rst>`_ section of the 
 | 
					Please see the `Quickstart <http://workload-automation.readthedocs.io/en/latest/user_information.html#user-guide>`_
 | 
				
			||||||
documentation.
 | 
					section of the documentation.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
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
 | 
					Documentation in reStructuredText format may be found under ``doc/source``. To
 | 
				
			||||||
compile it into cross-linked HTML, make sure you have `Sphinx
 | 
					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 is distributed under `Apache v2.0 License
 | 
				
			||||||
<http://www.apache.org/licenses/LICENSE-2.0>`_. Workload automation includes
 | 
					<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).
 | 
					directories).
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Feedback, Contrubutions and Support
 | 
					Feedback, Contributions and Support
 | 
				
			||||||
===================================
 | 
					===================================
 | 
				
			||||||
 | 
					
 | 
				
			||||||
- Please use the GitHub Issue Tracker associated with this repository for
 | 
					- Please use the GitHub Issue Tracker associated with this repository for
 | 
				
			||||||
 
 | 
				
			|||||||
		Reference in New Issue
	
	Block a user