docs: add README explaining the basics

This commit is contained in:
Julian Lobbes 2022-09-05 00:23:35 +02:00
parent 957792bf28
commit e0d512ea9b

15
README.md Normal file
View file

@ -0,0 +1,15 @@
# Docker beets
Container used to run the [beets](https://beets.readthedocs.io/en/stable/index.html) music library organizer.
## Quickstart
Copy `config.yaml` into the host volume's `config` folder (in this case `/srv/beets/config`).
Place the music you want to import into the `import` folder (in this case `/srv/beets/import`).
Run the beets importer interactively:
```bash
sudo docker exec -it beets beet import /import
```
The commandline and/or configuration reference [can be found here](https://beets.readthedocs.io/en/stable/index.html).