Recently Written · git

subread-android

SubRead for Android: times an audiobook against its ebook on the device

git clone https://github.com/equwal/subread-android

Log | Files | Refs


commit fa82b66f64f36667970137cee9c6d3e7a4f068b7
equwal <truex@equwal.com>
2026-09-20 21:23:31 -0700

Document the release procedure

 README.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)
diff --git a/README.md b/README.md
index c0cd615..6915255 100644
--- a/README.md
+++ b/README.md
@@ -46,6 +46,19 @@ still builds.
 
 The release key is not in the repository; CI reads it from Actions secrets.
 
+## Releases
+
+Each release is a tag (`vMAJOR.MINOR.PATCH`) and a GitHub release with the signed
+APK attached. The tag is the app's `versionName`:
+
+```bash
+./gradlew :app:assembleRelease -PversionName=0.2.0 -PversionCode=2
+git tag -a v0.2.0 -m "what changed" && git push origin main --tags
+gh release create v0.2.0 app/build/outputs/apk/release/app-release.apk --notes "what changed"
+```
+
+`versionCode` must go up every release, or Android refuses the update.
+
 ## Requirements
 
 Android 8+, a 64-bit ARM processor with ARMv8.2 half-precision and dot-product