Restructure README

This commit is contained in:
2026-10-11 13:46:30 +00:00
parent 1b52c5dbab
commit 6485a51249
+21 -41
View File
@@ -4,6 +4,8 @@
<h1 align="center">Fogwave</h1> <h1 align="center">Fogwave</h1>
<p align="center"><b>A calm, open-source internet radio app for Android.</b></p>
<p align="center"> <p align="center">
<a href="https://git.skysparkle.cc/kalarina/Fogwave/releases"><img src="assets/get-it-on-gitea.png" height="60" alt="Get it on Gitea"></a> <a href="https://git.skysparkle.cc/kalarina/Fogwave/releases"><img src="assets/get-it-on-gitea.png" height="60" alt="Get it on Gitea"></a>
</p> </p>
@@ -11,11 +13,10 @@
<p align="center"> <p align="center">
<img src="https://img.shields.io/github/downloads/kalarina-bit/Fogwave/latest/total?label=downloads&color=2e7d32&labelColor=1b1b1b" alt="downloads counter"> <img src="https://img.shields.io/github/downloads/kalarina-bit/Fogwave/latest/total?label=downloads&color=2e7d32&labelColor=1b1b1b" alt="downloads counter">
<img src="https://img.shields.io/badge/Android-7.0%2B-2e7d32?logo=android&logoColor=white&labelColor=1b1b1b" alt="Android 7.0+"> <img src="https://img.shields.io/badge/Android-7.0%2B-2e7d32?logo=android&logoColor=white&labelColor=1b1b1b" alt="Android 7.0+">
<img src="https://img.shields.io/badge/License-GPL--3.0--only-2e7d32?labelColor=1b1b1b" alt="GPL-3.0-only">
</p> </p>
**A calm, open-source internet radio app for Android.** Listen to Lithuania's favorite stations in one tap.
Listen to Lithuania's favorite stations in one tap — with background playback, a built-in equalizer, and a clean, distraction-free design.
## Features ## Features
@@ -23,12 +24,12 @@ Listen to Lithuania's favorite stations in one tap — with background playback,
- 🎧 **Background playback** with lock-screen, notification, headphone and Bluetooth controls - 🎧 **Background playback** with lock-screen, notification, headphone and Bluetooth controls
- 🚗 **Android Auto** support - 🚗 **Android Auto** support
- 🔄 **Auto-reconnect** when the stream drops or the network comes back - 🔄 **Auto-reconnect** when the stream drops or the network comes back
- 🎚️ **Equalizer** with presets, loudness boost and dynamics processing — settings are saved - 🎚️ **Equalizer** with presets, loudness boost and dynamics processing
- ❤️ **Favorites, recently played and similar stations** matched by genre - ❤️ **Favorites, recently played and similar stations** matched by genre
- 🗂️ **Four layouts** — list, table, tiles or icons, with adjustable size - 🗂️ **Four layouts** — list, table, tiles or icons, with adjustable size
- 🌙 **Clean, elegant UI** in a dark theme - 🌙 **Dark theme**
- 🌍 Available in English, Russian, German, Japanese, Lithuanian, and Chinese - 🌍 **Six languages** — English, Russian, German, Japanese, Lithuanian and Chinese
- 🔓 **100% open source** — no ads, no tracking, no accounts - 🔓 **No ads, no tracking, no accounts**
## Screenshots ## Screenshots
@@ -46,24 +47,18 @@ Listen to Lithuania's favorite stations in one tap — with background playback,
Requires **Android 7.0 (API 24) or newer**. Requires **Android 7.0 (API 24) or newer**.
1. Download the APK for the version you want from the [Releases page](https://github.com/kalarina-bit/Fogwave/releases). 1. Download the latest APK from the [Releases page](https://git.skysparkle.cc/kalarina/Fogwave/releases).
2. On your Android device, allow installs from unknown sources for the app you use to open the file (Settings → Apps → Special access → Install unknown apps). 2. Allow installs from unknown sources for the app you open it with (Settings → Apps → Special access → Install unknown apps).
3. Open the downloaded `.apk` file and confirm the install. 3. Open the `.apk` file and confirm the install.
Or via `adb` (after downloading):
```sh
adb install Fogwave-v1.0.11.apk
```
## Verifying a download ## Verifying a download
<img src="assets/icon-verify.png" width="36" align="left"> <img src="assets/icon-verify.png" width="36" align="left">
Every APK on the Releases page is signed with the same key. Check the signing certificate before installing: Every official APK is signed with the same key. Check it before installing:
```sh ```sh
apksigner verify --print-certs Fogwave-v1.0.11.apk apksigner verify --print-certs Fogwave-v<version>.apk
``` ```
The SHA-256 fingerprint of the signing certificate must be: The SHA-256 fingerprint of the signing certificate must be:
@@ -72,39 +67,24 @@ The SHA-256 fingerprint of the signing certificate must be:
1A:85:AF:5A:08:23:DE:D1:76:7C:07:55:41:FA:15:87:7F:6E:3B:99:9E:5E:52:CF:2B:C8:03:55:F6:63:12:7F 1A:85:AF:5A:08:23:DE:D1:76:7C:07:55:41:FA:15:87:7F:6E:3B:99:9E:5E:52:CF:2B:C8:03:55:F6:63:12:7F
``` ```
(`apksigner` prints the same value in lowercase without colons.) `apksigner` prints the same value in lowercase without colons. On Android you can check it with [AppVerifier](https://github.com/soupslurpr/AppVerifier) (app ID `cc.skysparkle.fogwave`).
On Android you can check it with [AppVerifier](https://github.com/soupslurpr/AppVerifier) (app ID `cc.skysparkle.fogwave`).
## Building from source ## Building from source
Requires JDK 17+ and Android Studio with Android SDK 37. Requires JDK 17+ and Android SDK 37.
```sh ```sh
./gradlew assembleDebug ./gradlew assembleDebug
``` ```
Release builds are signed only when a keystore is supplied through the `KEYSTORE_PATH`, `STORE_PASSWORD`, `KEY_ALIAS` and `KEY_PASSWORD` environment variables. Without them the release build is unsigned, which is what F-Droid expects. Keystores are excluded by `.gitignore` — never commit them. Release builds are signed only when a keystore is supplied through the `KEYSTORE_PATH`, `STORE_PASSWORD`, `KEY_ALIAS` and `KEY_PASSWORD` environment variables; otherwise the release build is unsigned, as F-Droid expects. Never commit keystores.
For every release: bump `versionCode` and `versionName` in `app/build.gradle.kts`, add `fastlane/metadata/android/<locale>/changelogs/<versionCode>.txt`, and tag the commit as `v<versionName>` (for example `v1.0.11`). ### Releasing
## Repository structure 1. Bump `versionCode` and `versionName` in `app/build.gradle.kts`.
2. Add `fastlane/metadata/android/<locale>/changelogs/<versionCode>.txt`.
<img src="assets/icon-structure.png" width="36" align="left"> 3. Tag the commit as `v<versionName>` (for example `v1.0.11`).
```
.
├── app/ # Android app source (Kotlin, Jetpack Compose)
├── assets/ # README images and logos
│ └── screenshots/ # App screenshots
├── fastlane/ # F-Droid store listing, screenshots and changelogs
├── gradle/ # Gradle wrapper and version catalog
├── LICENSE # GNU GPLv3
└── README.md
```
APK builds themselves are published as assets on the [Releases page](https://github.com/kalarina-bit/Fogwave/releases), not stored in this repository.
## License ## License
This project is licensed under the **GNU General Public License v3.0 only** (GPL-3.0-only) — see the [LICENSE](LICENSE) file for details. [GNU General Public License v3.0 only](LICENSE) (GPL-3.0-only).