update README.md
Some checks are pending
Android CI / build (push) Waiting to run

This commit is contained in:
Josia Pietsch 2025-02-16 16:51:18 +01:00
parent 5669279c64
commit 47ae0bf35f
Signed by: jrpie
GPG key ID: E70B571D66986A2D
3 changed files with 89 additions and 31 deletions

40
docs/build.md Normal file
View file

@ -0,0 +1,40 @@
# Building µLauncher
## Using the command line
Install JDK 17 and the Android Sdk.
Make sure that `JAVA_HOME` and `ANDROID_HOME` are set correctly.
```
git clone https://github.com/jrpie/Launcher
cd Launcher
./gradlew assembleDefaultRelease
```
This will create an apk file at `app/build/outputs/apk/default/release/app-default-release-unsigned.apk`.
Note that you need to sign it:
```
apksigner sign --ks "$YOUR_KEYSTORE" \
--ks-key-alias "$YOUR_ALIAS" \
--ks-pass="pass:$YOUR_PASSWORD" \
--key-pass="pass:$YOUR_PASSWORD" \
--alignment-preserved \
--v1-signing-enabled=true \
--v2-signing-enabled=true \
--v3-signing-enabled=true \
--v4-signing-enabled=true \
app-default-release-unsigned.apk
```
See [this guide](https://developer.android.com/build/building-cmdline)
for further instructions.
## Using Android Studio
Install [Android Studio](https://developer.android.com/studio), import this project and build it.
See [this guide](https://developer.android.com/studio/run)
for further instructions.