aboutsummaryrefslogtreecommitdiffhomepage
path: root/tools/skqp/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'tools/skqp/README.md')
-rw-r--r--tools/skqp/README.md49
1 files changed, 29 insertions, 20 deletions
diff --git a/tools/skqp/README.md b/tools/skqp/README.md
index cd3f0cdf3d..8d8810b514 100644
--- a/tools/skqp/README.md
+++ b/tools/skqp/README.md
@@ -1,37 +1,46 @@
-
SkQP
====
+SkQP (Skia Quality Program) is a component of the Android CTS (Compatablity
+Test Suite) that tests an Android device's GPU and OpenGLES & Vulkan drivers
+using Skia's existing unit & rendering tests.
+
How to run the SkQP tests
-------------------------
-1. Install Chromium's depot\_tools
+1. Get the dependencies:
+
+ - You will need `git` and `python`.
+
+ - Install Chromium's [depot\_tools](http://commondatastorage.googleapis.com/chrome-infra-docs/flat/depot_tools/docs/html/depot_tools_tutorial.html). Add it to your `PATH`.
+
+ git clone 'https://chromium.googlesource.com/chromium/tools/depot_tools.git'
+ export PATH="${PWD}/depot_tools:${PATH}"
- git clone 'https://chromium.googlesource.com/chromium/tools/depot_tools.git'
- export PATH="${PWD}/depot_tools:${PATH}"
+ - Install the [Android NDK](https://developer.android.com/ndk/downloads/).
-2. Install the [Android NDK](https://developer.android.com/ndk/downloads/).
+ ( cd ~; unzip ~/Downloads/android-ndk-*.zip )
+ ANDROID_NDK=$(ls ~/android-ndk-*) # Or wherever you installed the Android NDK.
- cd ~
- unzip ~/Downloads/android-ndk-*.zip
- ANDROID_NDK=~/android-ndk-* # Or wherever you installed the Android NDK.
+ - Install the [Android SDK](https://developer.android.com/studio/#command-tools).
+ Set the `ANDROID_HOME` environment variable.
-3. Install the [Android SDK](https://developer.android.com/studio/#command-tools)
+ mkdir ~/android-sdk
+ ( cd ~/android-sdk; unzip ~/Downloads/sdk-tools-*.zip )
+ yes | ~/android-sdk/tools/bin/sdkmanager --licenses
+ export ANDROID_HOME=~/android-sdk # Or wherever you installed the Android SDK.
- mkdir ~/android-sdk
- ( cd ~/android-sdk; unzip ~/Downloads/sdk-tools-*.zip )
- yes | ~/android-sdk/tools/bin/sdkmanager --licenses
- export ANDROID_HOME=~/android-sdk # Or wherever you installed the Android SDK.
+ Put `adb` in your `PATH`.
- Put `adb` in your `PATH`.
+ export PATH="${PATH}:${ANDROID_HOME}/platform-tools"
-4. Get the right version of Skia:
+2. Get the right version of Skia:
git clone https://skia.googlesource.com/skia.git
cd skia
git checkout origin/skqp/dev # or whatever release tag you need
-5. Download dependencies, the model, and configure the build. (If you want to
+3. Download dependencies, the model, and configure the build. (If you want to
test another architecture, replace `arm` with `x86`, `x64`, or `arm64`.)
python tools/skqp/download_model
@@ -40,14 +49,14 @@ How to run the SkQP tests
python tools/skqp/generate_gn_args out/skqp-arm "$ANDROID_NDK" arm
bin/gn gen out/skqp-arm
-6. Build, install, and run.
+4. Build, install, and run.
platform_tools/android/bin/android_build_app -C out/skqp-arm skqp
adb install -r out/skqp-arm/skqp.apk
adb logcat -c
adb shell am instrument -w org.skia.skqp/android.support.test.runner.AndroidJUnitRunner
-7. Monitor the output with:
+5. Monitor the output with:
adb logcat org.skia.skqp skia "*:S"
@@ -56,7 +65,7 @@ How to run the SkQP tests
01-23 15:22:12.688 27158 27173 I org.skia.skqp:
output written to "/storage/emulated/0/Android/data/org.skia.skqp/files/output"
-8. Retrieve and view the report with:
+6. Retrieve and view the report with:
OUTPUT_LOCATION="/storage/emulated/0/Android/data/org.skia.skqp/files/output"
adb pull $OUTPUT_LOCATION /tmp/
@@ -65,7 +74,7 @@ How to run the SkQP tests
Run as a non-APK executable
---------------------------
-1. Follow steps 1-5 as above.
+1. Follow steps 1-3 as above.
2. Build the SkQP program, load files on the device, and run skqp: