From 70a8e8e571685a89c66910dd66c1f40fe6550d98 Mon Sep 17 00:00:00 2001 From: Alexander Mahr Date: Tue, 4 Jul 2023 07:47:30 +0200 Subject: [PATCH] add a README.md --- README.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..29245ed --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +# Repo allowing -in a KISS way- to create a containered way to build an Android App APK + +## tl;dr + +to build an application + +1. modify the example minimal application source code found in +```bash +vim ./apk/Makefile +vim ./apk/..... (other files) +``` +2. run the compilation in the container (which is build via `Dockerfile` and `docker-compose.yml` upon first usage) +```bash +docker-compose run compile +``` + +this should result in the apk being build and be available at `./apk/app.apk` + +## Concepts and Ideals + +Many smart folks use [Android Studio](https://en.wikipedia.org/wiki/Android_Studio) IDE to build +Applications knowing the in and outs of what such an Android App amounts to. Sadly often the formerly +mentioned Software also allows for many less experienced or even uninformed persons to end up with +an Application, wiithout having had much or any insight what is really happening. The "comfort" and +assistence and overhead of the "automagic" support of the IDE might have drawbacks such as + +- more complex and hence less understood build system +- lower actual understanding of the build system +- dependence on the toolset and being basically "spoon-fed" +- lack of mastery and dominance and autonomy +- needless loss of insight +- ... (1001 further permutations of the previous criticisms)... + +To counteract this "generate an app via mouseclick", this repo strives to provide an alternative route +to build an Android application, that via its "Hello World" app example should allow to + +- generate a "hello world" application (and extend/grow/modify that) easily via CLI +- being portable and easily installable (hence the `docker compose`) +- reuse Makefile as an often familiar concept of "recipe" way to build the application + +