From b9c8933021f9b20f057f6a870f5f54ccdf43fc05 Mon Sep 17 00:00:00 2001 From: Alexander Capehart Date: Fri, 20 Dec 2024 22:47:13 -0500 Subject: [PATCH] musikr: add readme --- musikr/README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 musikr/README.md diff --git a/musikr/README.md b/musikr/README.md new file mode 100644 index 000000000..5ada89b29 --- /dev/null +++ b/musikr/README.md @@ -0,0 +1,21 @@ +# musikr + +Musikr is a highly opinionated multithreaded music library that enables Auxio's advanced music functionality. +It completely bypasses Android's MediaStore and uses the [storage access framework (SAF)](), [taglib]() to +replicate it's functionality with less bugs and more flexibility, further expanding it with an advanced music +model that is both fast and leverages some of the nice features within the MusicBrainz spec. + +There's not really a stable API surface for musikr right now, given that the music loader is still being +optimized and the rest of Auxio's modularization efforts are still in progress. Lots of useful stuff is +hidden, and lots of useless stuff is exposed. Eventually the API will start settling down into something +usable, but it will still require patches for your own project. + +Feel free to use this library as long as you follow Auxio's GPLv3 license and open-source all modifications. + +If you want to generate some docs for the unstable API, you can run + +```bash +./gradlew musikr:dokkaGeneratePublicationHtml +``` + +In the project root and it should produce a webpage in `musikr/build/dokka/html`