Improve README

Change-Id: I1997531eea1b8a395915361f40dcdcf5863e3916

1 files changed, 77 insertions, 21 deletions

diff --git a/README b/README
index d5b4b8f..2c689b6 100644
--- a/README
+++ b/README
@@ -2,35 +2,79 @@ Android For Work (Afw) Test Harness
 -----------------------------------------------------
 About
 
-Afw Test Harness is designed to validate Android for Work compativility of
-Android devices. It's a test suite consisting of apps, test cases and the test
-runner. The test runner, afw-test-tradefed, is built on top of cts-tradefed.
-The way of building & running Afw Test Harness is quite similar to CTS.
+Afw Test Harness is designed to validate Android for Work compatibility of
+Android devices. It's a test suite consisting of support apps, test cases,
+test runner and configuration files. The test runner, afw-test-tradefed,
+is built on top of cts-tradefed. The way of building & running Afw Test
+Harness is quite similar to CTS.
 
 
-Build & Run
------------
-1. Build the suite: make afw-test-harness
+Host Machine Setup
+------------------
+1. Ensure 'adb' is in your current PATH. adb can be found in the
+Android SDK available from http://developer.android.com
 
-   Similar to CTS, "make afw-test-harness" will create a directory,
+Example:
+  PATH=$PATH:/home/myuser/android-sdk-linux_x86/platform-tools
 
-     out/host/<platform>/afw-test/android-cts,
+2. Connect the device to the host machine.
 
-   which contains all necessary binaries, configuration files and tools to
-   run the test suite. This directory is also zipped into a zip file,
-   android-afw-test-harness.zip, for distribution.
+3. Ensure device is visible via 'adb devices'
 
-   To run afw-test locally, you need a testing account, which can be obtained
-   from https://android-for-work-test-harness.appspot.com.
+4. Make sure Java Runtime 1.7 or 1.8 is installed
 
-   Add the account & password to afw-test.props file, for key "work_account_username"
-   and "work_account_password" correspondingly.
-   You might need to re-build the harness so that the account is picked up.
-   Double check the account and password are in output file:
 
-   out/host/<platform>/afw-test/android-cts/repository/testcases/afw-test.props
+Afw Test Harness Configurations
+-------------------------------
+1. Get Testing Work account
 
-2. Launch tradefed: afw-test-tradefed
+Testing work account is required to run the test harness. Testing work account
+can be obtained from https://android-for-work-test-harness.appspot.com/.
+Please reach out to the Google point of contact within your company to generate
+these accounts.
+Once obtained the testing account, specify it in the test harness configuration
+file, afw-test.props, with the following properties:
+
+work_account_username
+work_account_password
+
+2. Configure WIFI network
+
+Configure the Wi-Fi network in afw-test.props with the following properties:
+
+wifi_ssid
+wifi_password (optional)
+wifi_security_type (optional, available options are: NONE, WEP or WPA)
+
+
+Build Afw Test Harness
+----------------------
+To build Afw Test Harness, browse to this directory and then:
+
+  make afw-test-harness
+
+Similar to CTS, "make afw-test-harness" will create a directory,
+
+  out/host/<platform>/afw-test/android-cts
+
+which contains all necessary binaries, configuration files and tools to run the
+test suite. This directory is also zipped into a file, android-afw-test-harness.zip,
+for distribution.
+
+
+Run Afw Test Harness
+----------------------------------------------
+1. From building environment, launch the test runner from the command line:
+
+  afw-test-tradefed
+
+2. From the unzipped folder of android-afw-test-harness.zip, launch the test
+   runner from the command line:
+
+  ./android‐cts/tools/afw-test‐tradefed
+
+  Make sure the ./android‐cts/repository/testcases/afw-test.props has the
+  testing work account and WIFI configuration.
 
 3. Run the test plan "afw-userdebug-build": run cts --plan afw-userdebug-build
 
@@ -50,5 +94,17 @@ Build & Run
 
    run cts --package com.google.android.afwtest.NfcProvisioning
 
-   All packages can be found by executing "list packages" command in afw-test-tradefed console.
+   All packages can be found by executing "list packages" command in
+   afw-test-tradefed console.
+
+5. If the device supports both 64 bits & 32 bits abi, you can force the test
+   harness to run on a specific abi, e.g.:
+
+   run cts --plan afw-userdebug-build --force-abi 64
+
+6.For more options: 'run cts --help'
+
 
+Support
+-------
+Contact afw-testharness-support@google.com if you have any questions.