add README for explanation

emilk · Sep 5, 2024 · c972432 · c972432
1 parent 828bd40
commit c972432
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/android/README.md b/android/README.md
@@ -0,0 +1,14 @@
+# eframe in android
+
+This part of the repo will build an android app using a `cdylib` named `eframe_template_android`. This `cdylib` will be used by the android app to render the UI.
+
+The chain is: `eframe_template` used in `eframe_template_android` used in `eframe_template` (android app)
+
+## Building the android app
+
+```sh
+# will compile the cdylib and copy it to the android app
+make
+
+make run-on-device
+```