Update README.md

This commit is contained in:
Daniel O'Neill 2026-01-10 04:38:12 +00:00
parent 2c9f8932c0
commit 68fc1bd50d

View file

@ -1,3 +1,43 @@
# Audiobooks
An audiobook player for Plasma Mobile
An audiobook player for Plasma Mobile
![Screenshot of Library page on a OnePlus 6T](https://oneill.app/~doneill/Audiobooks/library.png)
![Screenshot of Now Playing page on a OnePlus 6T](https://oneill.app/~doneill/Audiobooks/nowplaying.png)
## Dependencies
- Qt 6.8+
- libmpv
- KF6KIOCore
- KF6KIOGui
- KF6CoreAddons
- Kirigami
## Building
```bash
$ git clone --depth 1 "https://oneill.app:3030/doneill/Audiobooks.git"
$ mkdir Audiobooks/build
$ cd Audiobooks/build
$ qmake6 ..
$ make -j$(nproc)
$ ./Audiobooks
```
## Using
Any audiobooks in a supported format (m4b, at this time) should be placed into `~/Documents/Audiobooks`.
On application startup this location will be scanned, and new books will be imported automatically.
## Notes
It will also build and run on anything that can run Plasma provided you have suitable development dependencies.
It's pretty basic at this point, but I hope to implement new features as I use it.
Additional pieces to make it more "KDE compliant" are also in the works.
For any questions, bugs, patches, or requests, I can be reached via Matrix at @vallidor:envs.net.