From 92bf3cac80883a2ba6b80c4e5f7b127c14b0a9c2 Mon Sep 17 00:00:00 2001
From: Juan Ramos <juan@lunarg.com>
Date: Wed, 11 Oct 2023 16:06:45 -0600
Subject: docs: Cleanup BUILD.md and various other documents

- Fixup build documentation up to standard set by VVL
- Add documentation for running vkcube/vulkaninfo on Android
- Make BUILD_WERROR off by default
- Remove out of date documentation
- Remove pointless documentation

closes #791
---
 tests/README.md | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)
 create mode 100644 tests/README.md

(limited to 'tests')

diff --git a/tests/README.md b/tests/README.md
new file mode 100644
index 00000000..0e0798e7
--- /dev/null
+++ b/tests/README.md
@@ -0,0 +1,34 @@
+## Android
+
+### Running vkcube on Android
+
+```sh
+cd Vulkan-Tools
+
+cd build-android
+
+# Optional
+adb uninstall com.example.VkCube
+
+adb install -r -g --no-incremental bin/VkCube.apk
+
+adb shell am start com.example.VkCube/android.app.NativeActivity
+```
+
+### vulkaninfo on Android
+
+Unlike `vkcube`, `vulkaninfo` doesn't require the extra step of creating an `APK`.
+
+So the following should be enough.
+
+```sh
+cd Vulkan-Tools
+
+scripts/android.py --config Release --app-abi arm64-v8a --app-stl c++_static --clean
+
+adb push build-android/cmake/arm64-v8a/vulkaninfo/vulkaninfo /data/local/tmp
+
+adb shell /data/local/tmp/vulkaninfo --json --output /data/local/tmp/foobar.json
+
+adb pull /data/local/tmp/foobar.json
+```
-- 
cgit v1.2.3