diff --git a/BUILD_FDROID.md b/BUILD_FDROID.md index f4cf6d9..e43e87b 100644 --- a/BUILD_FDROID.md +++ b/BUILD_FDROID.md @@ -9,6 +9,7 @@ The app includes specific configurations for F-Droid compatibility: 1. A dedicated `fdroid` product flavor that excludes Google Fonts 2. A specific `fdroidRelease` build type 3. System fonts are used instead of Google Fonts for the F-Droid version +4. The F-Droid build is **not signed** (as per [PR #106](https://github.com/usetrmnl/trmnl-android/pull/106)) - F-Droid handles the signing process ## Building the F-Droid Version @@ -18,7 +19,7 @@ To build the F-Droid version locally: ./gradlew assembleFdroidRelease ``` -This will generate an APK in `app/build/outputs/apk/fdroid/release/` that is suitable for F-Droid. +This will generate an unsigned APK in `app/build/outputs/apk/fdroid/release/` that is suitable for F-Droid submission. Unlike the standard release build, the F-Droid build variant does not have a signing configuration, as F-Droid's build system will handle the signing process. Alternatively, you can use the convenience task: @@ -56,3 +57,5 @@ Ensure the following are available: - The app is licensed under the MIT license - F-Droid metadata is complete - The app builds successfully with the F-Droid build system + +Note that F-Droid will build and sign the app themselves using their own signing key. Our build process intentionally does not include a signing configuration for the F-Droid variant (as implemented in [PR #106](https://github.com/usetrmnl/trmnl-android/pull/106)). diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 95bdc3e..22fbd06 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -88,6 +88,14 @@ To build specific variants: ./gradlew buildAllFlavors ``` +For more details on the F-Droid build process, see [BUILD_FDROID.md](BUILD_FDROID.md). App! This document provides guidelines and instructions to help you contribute effectively. + + +### Release Process + +For instructions on creating new releases and managing versions across the project, see the [Release Checklist](RELEASE_CHECKLIST.md). + + ### Snapshot Builds Automatic snapshot release builds are available in the [release workflow](https://github.com/usetrmnl/trmnl-android/actions/workflows/android-release.yml) artifacts. diff --git a/README.md b/README.md index 7f3092f..01acdc1 100644 --- a/README.md +++ b/README.md @@ -55,10 +55,6 @@ The app will *soon* be available on F-Droid, providing a free and open source An ## android logoAndroid Development & Contribution Guide See [CONTRIBUTING.md](CONTRIBUTING.md) for more details on how to get started and contribute to the project. -### Release Process - -For instructions on creating new releases and managing versions across the project, see the [Release Checklist](RELEASE_CHECKLIST.md). - --- ## Related References 📖