diff --git a/README.md b/README.md index 1bf4008..5417434 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,41 @@ -# Android App +# Android App (build via docker/podman) + +The goal of this repo, is to create a container that can serve to produce an "empty android Application" (i.e `app.apk` file). +As such the philosophy is to keep the process "simple" as to now make the understanding too difficult. + +## basic ideas + +* work within container (debian based image) +* use Makefile as a build tool + +## basic info + +This repo should allow to generate an empty "android app". by simply cloning this repo and +``` +./build-android-app.sh +``` +It does so via: + +1. building a container (in any of the runtime/daemons it finds: i.e. docker,podman,etc..) +2. running this container having the `./app` folder being mounted within as `/app` +3. executing the [`app/Makefile`](app/Makefile) which will then: +4. either work with the configuration stored in an `app/app-config.sh` in case such file exists or +5. if not go through a `whiptail` text menu wizzard to configure a new empty app. (Makefile recipe: `./app-config.sh`) +6. it will then download the required android sdk files as necessary (Makefile recipe: `./android-sdk/installed`) +7. go through the further steps to setup the blank app. +## usage + +1. run + +``` +./build-android-app.sh +``` + +2. follow the configuration +3. upon success the apk file created is in app/result/app.apk and can be installed via `adb` +``` +adb install -r app/result/app.apk +``` +