diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d19c49e..6a3c957 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -71,12 +71,16 @@ To build a debug APK: ./gradlew assembleDebug ``` -### Build Variants -The app supports multiple build variants: -- **Standard**: The default variant with all features -- **F-Droid**: A variant optimized for F-Droid distribution without Google dependencies +### Build Types +The app uses standard Android build types (debug and release). There are no product flavors. -To build specific variants: +**Build Types:** +- **Debug**: Development builds with fake API support and debug keystore +- **Release**: Production builds with code shrinking, ProGuard, and production keystore + +The release build is F-Droid compatible (no Google dependencies, `dependenciesInfo.includeInApk = false`). + +To build the release APK: ```bash # Build the release variant ./gradlew assembleRelease diff --git a/keystore/README.md b/keystore/README.md index 2ef948f..3a12ceb 100644 --- a/keystore/README.md +++ b/keystore/README.md @@ -14,12 +14,14 @@ signing the app during development. ## Production Keystore -The production keystore (`trmnl-app-release.keystore`) is used for all release builds (both standard and F-Droid flavors) and is stored as a base64-encoded secret in GitHub Actions. The keystore is decoded during CI/CD builds. +The production keystore (`trmnl-app-release.keystore`) is used for all release builds and is stored as a base64-encoded secret in GitHub Actions. The keystore is decoded during CI/CD builds. -### Build Flavors Using Production Keystore +**Note:** This project uses only build types (debug/release), not product flavors. There is no separate F-Droid flavor. The release build is F-Droid compatible by default. -- **Standard Release**: Signs APKs for general distribution -- **F-Droid Release**: Signs APKs for F-Droid distribution (F-Droid will verify the signature during their reproducible build process) +### Release Build Distribution + +- **General Distribution**: Release APK signed with production keystore +- **F-Droid Distribution**: Same release APK (F-Droid verifies the signature during their reproducible build process) ### Important Notes About the Production Keystore