diff --git a/README.md b/README.md index 346c48f..1edc1d5 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,34 @@

- Matewave icon + Matewave icon

Matewave

-

A beautiful, open-source chess app for Android.

-

- Get it on Gitea + A beautiful, open-source chess app for Android.
+ Play against the AI, solve puzzles, learn openings, or play friends nearby over Bluetooth and Wi-Fi/LAN.

- Android 8.0+ - GPL-3.0-or-later + Latest release

-Play against the AI, solve puzzles, learn openings, or play friends nearby over Bluetooth and Wi-Fi/LAN. +

+ Get it on F-Droid + Get it on Obtainium + Get it on GitHub + Get it on Gitea +

-## Features +

+ Make your next move count + Home screen + From solo games to friendly matches + Play together + Keep growing +

+ +## ✨ Features - 🤖 **AI opponent** with adjustable difficulty - 🧩 **Puzzles** and tactical training @@ -28,27 +39,13 @@ Play against the AI, solve puzzles, learn openings, or play friends nearby over - 🌙 **Dark theme** - 🌍 **Six languages** — English, Russian, German, Japanese, Lithuanian and Chinese -## Screenshots +## Installation -

- Make your next move count - Home screen - From solo games to friendly matches - Play together - Keep growing -

+- **[F-Droid](https://f-droid.org/packages/cc.skysparkle.matewave/)** — install and update through the F-Droid client. +- **[Obtainium](https://apps.obtainium.imranr.dev/redirect?r=obtainium://add/https://github.com/kalarina-bit/Matewave)** — installs the APK straight from GitHub releases and keeps it up to date. +- **Manually** — download the latest APK from [GitHub](https://github.com/kalarina-bit/Matewave/releases/latest) or [Gitea](https://git.skysparkle.cc/kalarina/Matewave/releases), allow installs from unknown sources for the app you open it with (Settings → Apps → Special access → Install unknown apps), then open the `.apk` and confirm. -## Installation - - - -1. Download the latest APK from the [Releases page](https://git.skysparkle.cc/kalarina/Matewave/releases). -2. Allow installs from unknown sources for the app you open it with (Settings → Apps → Special access → Install unknown apps). -3. Open the `.apk` file and confirm the install. - -## Verifying a download - - +## Verifying a download Every official APK is signed with the same key. Check it before installing: @@ -64,7 +61,7 @@ The SHA-256 fingerprint of the signing certificate must be: `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.matewave`). -## Building from source +## Building from source Requires JDK 17+ and Android Studio with AGP 9.2 support. @@ -75,10 +72,10 @@ Requires JDK 17+ and Android Studio with AGP 9.2 support. Nearby multiplayer needs two physical devices — the emulator has no real Bluetooth, and mDNS discovery is often blocked on emulator networks. -## Contributing +## 🤝 Contributing Bug reports, puzzle and opening fixes, translation fixes and pull requests are welcome in the [issue tracker](https://git.skysparkle.cc/kalarina/Matewave/issues). Please read [CONTRIBUTING.md](CONTRIBUTING.md) first — it explains what fits the project and how to send changes. To open an issue or a pull request, [create an account](https://git.skysparkle.cc/user/sign_up) on this Gitea. -## License +## 📄 License [GNU General Public License v3.0 or later](LICENSE).