Add README with project overview and build instructions
This commit is contained in:
parent
b11974617a
commit
05e14147d9
55
README.md
Normal file
55
README.md
Normal file
@ -0,0 +1,55 @@
|
||||
# KaRemote
|
||||
|
||||
Android remote control app for [Karadio32](https://github.com/karawin/Ka-Radio32) internet radio receivers.
|
||||
|
||||
## Features
|
||||
|
||||
- Play/stop, volume control, station switching
|
||||
- Station list with search via [RadioBrowser.info](https://www.radio-browser.info/)
|
||||
- Station favicons and metadata (genre, bitrate, codec)
|
||||
- Real-time status polling
|
||||
- Light/dark/system theme with multiple color palettes
|
||||
- Dynamic color (Material You) support
|
||||
- Landscape layout support
|
||||
|
||||
## Screenshots
|
||||
|
||||
*Coming soon*
|
||||
|
||||
## Requirements
|
||||
|
||||
- Android 13 (API 33) or higher
|
||||
- Karadio32 device on the same network
|
||||
|
||||
## Building
|
||||
|
||||
Requires JDK 17+.
|
||||
|
||||
```bash
|
||||
# Debug build
|
||||
./gradlew assembleDebug
|
||||
|
||||
# Release build
|
||||
./gradlew assembleRelease
|
||||
```
|
||||
|
||||
## Tech Stack
|
||||
|
||||
- Kotlin + Jetpack Compose
|
||||
- Material 3 (Material You)
|
||||
- Hilt (dependency injection)
|
||||
- Retrofit + OkHttp (networking)
|
||||
- Coil (image loading)
|
||||
- DataStore Preferences (local storage)
|
||||
|
||||
## Privacy
|
||||
|
||||
KaRemote does not collect any personal data. See [Privacy Policy](PRIVACY_POLICY.md) for details.
|
||||
|
||||
## License
|
||||
|
||||
Copyright (C) 2026 Pavel Baksy
|
||||
|
||||
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
|
||||
|
||||
See [LICENSE](LICENSE) for the full text.
|
||||
Loading…
x
Reference in New Issue
Block a user