From 09444ce35a1e2ddb173e43d03198a44e58dcbf35 Mon Sep 17 00:00:00 2001
From: Alexander Mahr <info@alexmahr.de>
Date: Wed, 25 Dec 2024 22:42:26 +0100
Subject: [PATCH] improve README.md

---
 README.md | 40 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)

diff --git a/README.md b/README.md
index 5417434..f7d40d0 100644
--- a/README.md
+++ b/README.md
@@ -39,3 +39,43 @@ It does so via:
 adb install -r app/result/app.apk 
 ```
 
+## files and purpose
+
+Upon `clone` of this repo the `app` folder is setup with these files:
+```
+# The (GNU) Makefile which...
+app/Makefile
+# ... has recipes that call scripts in folder....
+app/.Makefile.scripts
+# .. which creates an `app-config.sh`, a file to keep
+# the configuration (app name,lable,api-levels,permissions etc)...
+app/.Makefile.scripts/make--app-config.sh
+# .. which creates an `AndroidManifest.xml`
+app/.Makefile.scripts/make--AndroidManifest.xml
+# .. which creates an `AppActivity.java` file (which just setup a Webview and loads `assets/index.html`)
+app/.Makefile.scripts/make--AppActivity.java.sh
+# .. which installs the necessary Android SDK in the correct versions
+app/.Makefile.scripts/make--android-sdk.sh
+app/assets
+# the index.html file 
+app/assets/index.html
+app/res
+app/res/drawable
+# the icon of the app
+app/res/drawable/appicon.xml
+```
+
+Upon further `./build-android-app.sh` execution more folders will appear
+```
+# a folder in which the Android-sdk stuff (installed via sdkmanager) is stored
+android-sdk  
+# folders used during build...
+# ... for temporary files 
+bin/
+obj/
+result/
+# app configuration resulting from text whiptail menu
+app-config.sh
+# the Manifest file as resulted from data from app-config.sh
+AndroidManifest.xml 
+```