aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJaebaek Seo <duke.acacia@gmail.com>2019-01-10 17:43:21 -0500
committerGitHub <noreply@github.com>2019-01-10 17:43:21 -0500
commitd6a750e0fe966516e9b799bba55fb295e124a81b (patch)
tree1ff91cd882500a1444da04e20f6d1a34ac6503e9 /README.md
parent610296cc045b094509a6bd2f420ebdef1f98edf9 (diff)
downloadamber-d6a750e0fe966516e9b799bba55fb295e124a81b.tar.gz
Add a sample Android app (#183)
Fixes #179
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index d75bcaa..c95b297 100644
--- a/README.md
+++ b/README.md
@@ -42,6 +42,20 @@ cmake -GNinja ../..
ninja
```
+### Android
+
+* Android build needs Android SDK 28, Android NDK 16, Java 8. If you prefer
+ other versions of Android SDK, Android NDK, Java, then you can change
+ `ANDROID_PLATFORM` and `ANDROID_BUILD_TOOL_VERSION` in
+ `tools/build-amber-sample.sh`.
+* Set up Android SDK path by running
+ `export ANDROID_SDK_HOME=path/to/Android/SDK` in your shell.
+* Set up Android NDK path by running
+ `export ANDROID_NDK_HOME=path/to/Android/NDK` in your shell.
+* Generate a KeyStore using `keytool` command and set up `KEY_STORE_PATH`
+ env variable for the KeyStore file path.
+* Run `./tools/build-amber-sample.sh [build output directory path]`.
+
### Optional Components
Amber, by default, enables testing, SPIRV-Tools and Shaderc. Each of these can