1 files changed, 29 insertions, 0 deletions
diff --git a/platform/android/MapboxGLAndroidSDKRenderTest/README.md b/platform/android/MapboxGLAndroidSDKRenderTest/README.md
new file mode 100644
index 0000000000..f59134c0d5
--- /dev/null
+++ b/platform/android/MapboxGLAndroidSDKRenderTest/README.md
@@ -0,0 +1,29 @@
+# Install
+
+Run `yarn install` from the root of this module to pull in external dependencies.
+
+# Generate
+
+Generate tests with `yarn gen`:
+ - copies style.json, expected image to `src/main/assets`
+ - generates instrumentation tests in `src/androidTest`
+ 
+# Build
+
+Build tests with `yarn build`, this generates 2 apks files that can be uploaded to cloud testing services in `build/outputs/apk`.
+ 
+# Run
+
+Run tests locally on a device with `yarn test`. 
+
+# Retrieve test results
+
+Use `yarn pull` to retrieve test results stored in `sdcard/mapbox/render` from the test device and store them in `build/outputs/render`.
+
+# Pixelmatch
+
+Use `yarn pixelmatch` to run [pixelmatch](https://github.com/mapbox/pixelmatch) on `build/outputs/render` subdirectories.
+
+# Clean
+
+Run `yarn clean` to cleanup build, tests and assets. 
+\ No newline at end of file