From 43335222568c66bf2be159a54ac20548c5b4713e Mon Sep 17 00:00:00 2001 From: austinried <4966622+austinried@users.noreply.github.com> Date: Sat, 3 Oct 2026 23:45:47 +0000 Subject: [PATCH] docs: rebuild the README for the native rewrite --- README.md | 70 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 70 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 00000000..214224f5 --- /dev/null +++ b/README.md @@ -0,0 +1,70 @@ +
+
+
+
+
+
+
+
+## Download
+
+
+
+## Features
+
+- Home screen to browse your library over many categories, genres, and more
+- Album and artist artwork, shown full-resolution in the detail and now playing views
+- Downloads with album, artist and playlist bulk downloads, download quality and a metered-connection toggle
+- Search across albums, artists, playlists and songs, with per-list sort and filter controls
+- Gapless playback, an editable queue you can reorder and jump through, and loop and shuffle modes
+- Up next queue to add items into the currently playing queue without rewriting it
+- Multiple server support with quick switching
+- Stream quality (bitrate and format) settings for Wi-Fi and mobile and automatic switching
+- Scrobbling and starred items, cached while offline and sent back to the server when online
+- Media notification and headset/Bluetooth controls
+- Adaptive theming from the current song's artwork
+
+The full library is mirrored at sync, so browsing, searching, sorting and filtering all work without waiting on the server. Only media and artwork are fetched on demand, and not even that when they're already downloaded.
+
+## Building
+
+The project's entire toolchain is provided by a Nix flake. The default devshell provides JDK, Gradle and the Android SDK, so there is nothing to install by hand.
+
+Therefore, to get started, you'll need to install Nix. I prefer [Lix](https://lix.systems/install/).
+
+```sh
+nix develop
+gradle :app:assembleDebug
+```
+
+Test, lint and screenshot commands, plus the integration harness, are documented in [AGENTS.md](AGENTS.md). The architecture is described in [docs/architecture.md](docs/architecture.md).
+
+## Translations
+
+Want to see subtracks in your language? Visit the project on [Weblate](https://hosted.weblate.org/engage/subtracks/) to help!
+
+
+