docs: enhance README.md with detailed table of contents and examples for source and output structure
This commit is contained in:
parent
7611a9f4cb
commit
39a341d193
1 changed files with 57 additions and 24 deletions
81
README.md
81
README.md
|
@ -8,6 +8,24 @@ der Ordnerstruktur extrahiert und als Tags gesetzt. Die Ergebnisse werden unter
|
||||||
|
|
||||||
> Das Skript startet `m4b-tool` über Nix (`nix run github:sandreas/m4b-tool#m4b-tool-libfdk`).
|
> Das Skript startet `m4b-tool` über Nix (`nix run github:sandreas/m4b-tool#m4b-tool-libfdk`).
|
||||||
|
|
||||||
|
## Inhaltsverzeichnis
|
||||||
|
|
||||||
|
- [to-m4b](#to-m4b)
|
||||||
|
- [Inhaltsverzeichnis](#inhaltsverzeichnis)
|
||||||
|
- [Voraussetzungen](#voraussetzungen)
|
||||||
|
- [Quickstart](#quickstart)
|
||||||
|
- [Verzeichnisstruktur](#verzeichnisstruktur)
|
||||||
|
- [Ausgabepfade](#ausgabepfade)
|
||||||
|
- [Verwendete Tags](#verwendete-tags)
|
||||||
|
- [Nutzung](#nutzung)
|
||||||
|
- [Konfiguration](#konfiguration)
|
||||||
|
- [Beispiele](#beispiele)
|
||||||
|
- [Quelle (src):](#quelle-src)
|
||||||
|
- [Ergebnis (out):](#ergebnis-out)
|
||||||
|
- [Fehlersuche](#fehlersuche)
|
||||||
|
- [Hinweise](#hinweise)
|
||||||
|
|
||||||
|
|
||||||
## Voraussetzungen
|
## Voraussetzungen
|
||||||
|
|
||||||
- Nix installiert (für den Aufruf von `m4b-tool` via `nix run`)
|
- Nix installiert (für den Aufruf von `m4b-tool` via `nix run`)
|
||||||
|
@ -109,36 +127,51 @@ Wenn du `m4b-tool` lokal ohne Nix verwenden willst, kannst du den Aufruf in
|
||||||
|
|
||||||
## Beispiele
|
## Beispiele
|
||||||
|
|
||||||
Serien‑Quelle (src):
|
### Quelle (src):
|
||||||
|
|
||||||
```
|
```
|
||||||
src/WinterZeit Verlag/Das Schwarze Auge/Book 15 - 2022 - Auf Schusters Rappen/
|
src/ (Source Directory, für Hör-bücher/-spiele)
|
||||||
249_Das schwarze Auge_Teil 1 - Folge 15_ Auf Schusters Rappen.ogg
|
├── 'Corvus Corax'/ (Author)
|
||||||
250_Das schwarze Auge_Teil 2 - Folge 15_ Auf Schusters Rappen.ogg
|
│ └── '2017 - Der Fluch des Drachen'/ (Jahr - Titel)
|
||||||
...
|
│ ├── '101 - Einführung.flac' (Audiodateien)
|
||||||
|
│ ├── '102 - Nimmer mehr (Die Ballade von Adamas) (Hörbuch Edit).flac'
|
||||||
|
│ ├── '...'
|
||||||
|
│ ├── '...'
|
||||||
|
│ ├── '224 - Wer hat euch vom Schmied erzählt.flac'
|
||||||
|
│ └── cover.jpg (Cover-Bild für das m4b Hörbuch)
|
||||||
|
└── 'WinterZeit Verlag'/ (Author)
|
||||||
|
└── 'Das Schwarze Auge'/ (Serien Titel)
|
||||||
|
├── 'Book 1 - 2017 - Im Kerker von Gareth'/ (Book <Serien index> - Jahr - Title)
|
||||||
|
│ ├── '001_Das schwarze Auge_Teil 1 - Folge 1_ Im Kerker von Gareth.ogg' (Audiodateien)
|
||||||
|
│ ├── '002_Das schwarze Auge_Teil 2 - Folge 1_ Im Kerker von Gareth.ogg'
|
||||||
|
│ ├── '...'
|
||||||
|
│ ├── '...'
|
||||||
|
│ ├── '017_Das schwarze Auge_Teil 17 - Folge 1_ Im Kerker von Gareth.ogg'
|
||||||
|
│ ├── cover.jpg (Cover-Bild für das m4b Hörbuch)
|
||||||
|
│ └── description.txt (Beschreibung für das m4b Hörbuch)
|
||||||
|
└── 'Book 2 - 2017 - Freund oder Feind'/
|
||||||
|
├── '018_Das schwarze Auge_Teil 1 - Folge 2_ Freund oder Feind.ogg'
|
||||||
|
├── '019_Das schwarze Auge_Teil 2 - Folge 2_ Freund oder Feind.ogg'
|
||||||
|
├── '...'
|
||||||
|
├── '...'
|
||||||
|
├── '035_Das schwarze Auge_Teil 18 - Folge 2_ Freund oder Feind.ogg'
|
||||||
|
├── cover.jpg
|
||||||
|
└── description.txt
|
||||||
```
|
```
|
||||||
|
|
||||||
Serien‑Ergebnis (out):
|
### Ergebnis (out):
|
||||||
|
|
||||||
```
|
```
|
||||||
out/WinterZeit Verlag/Das Schwarze Auge/Book 15 - 2022 - Auf Schusters Rappen/
|
out/ (Output Directory, für die m4b Hör-bücher/-spiele)
|
||||||
2022 - Auf Schusters Rappen.m4b
|
├── 'Corvus Corax'/ (Author)
|
||||||
```
|
│ └── '2017 - Der Fluch des Drachen'/ (Jahr - Titel)
|
||||||
|
│ └── '2017 - Der Fluch des Drachen.m4b' (Fertiges m4b Hörbuch)
|
||||||
Einzelband‑Quelle (src):
|
└── 'WinterZeit Verlag'/ (Author)
|
||||||
|
└── 'Das Schwarze Auge'/ (Serien Titel)
|
||||||
```
|
├── 'Book 01 - 2017 - Im Kerker von Gareth'/ (Book <Serien index> - Jahr - Title)
|
||||||
src/Corvus Corax/2017 - Der Fluch des Drachen/
|
│ └── '2017 - Im Kerker von Gareth.m4b' (Fertiges m4b Hörbuch -- Jahr - Titel.m4b)
|
||||||
101_Intro.flac
|
└── 'Book 02 - 2017 - Freund oder Feind'/ (Book <Serien index> - Jahr - Title)
|
||||||
102_Nimmer mehr (Die Ballade von Adamas).flac
|
└── '2017 - Freund oder Feind.m4b' (Fertiges m4b Hörbuch -- Jahr - Titel.m4b)
|
||||||
...
|
|
||||||
```
|
|
||||||
|
|
||||||
Einzelband‑Ergebnis (out):
|
|
||||||
|
|
||||||
```
|
|
||||||
out/Corvus Corax/2017 - Der Fluch des Drachen/
|
|
||||||
2017 - Der Fluch des Drachen.m4b
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fehlersuche
|
## Fehlersuche
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue