From: Bastian Dehn <hhaalo@arcor.de>
Date: Sat, 26 Sep 2026 17:17:26 +0000 (+0200)
Subject: add readme
X-Git-Tag: v1.0.0^2
X-Git-Url: https://gitweb.hhaalo.de/?a=commitdiff_plain;h=refs%2Fheads%2Fdevelop;p=albentohandy.git

add readme
---

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..a19f272
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,48 @@
+# albentohandy
+
+convert flac to ogg, mp3, opus or flac from music collection
+
+## config required
+
+Variable `MUSIC_PATH` is required default is `$HOME/Music`
+
+```bash
+cp src/albentohandy.conf $HOME/.albentohandy.conf
+```
+
+## music collection
+
+my collection structure
+
+```bash
+/path/to/collection/
+├── Alben
+│   ├── ACDC
+│   ├── ...
+```
+
+## run
+
+create `albumlist` file with follow content:
+
+```txt
+Alben/ACDC
+```
+run in the same folder `albentohandy`
+
+```bash
+./paht/to/src/albentohandy
+```
+
+default convert into vorbis ogg file
+
+## build deb package
+
+```bash
+make package
+```
+or build with builder container
+
+```
+./builder/builder
+```
\ No newline at end of file