improved documentation

This commit is contained in:
Josia Pietsch 2025-05-09 23:54:23 +02:00
parent 6d271970fe
commit 49785e66f2
Signed by: jrpie
GPG key ID: E70B571D66986A2D
12 changed files with 173 additions and 101 deletions

45
docs/build.md Normal file
View file

@ -0,0 +1,45 @@
# Building from Source
## Using the command line
Install JDK 17 and the Android SDK.
Make sure that `JAVA_HOME` and `ANDROID_HOME` are set correctly.
```bash
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:
```bash
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. How to
## CI Pipeline
The [CI pipeline](https://github.com/jrpie/Launcher/actions) automatically creates debug builds.
> Note: These builds are *not* signed. They are in built in debug mode and only suitable for testing.