pentaradio-tools/README.md

57 lines
1.7 KiB
Markdown
Raw Normal View History

2022-04-17 00:27:08 +02:00
# pentaradio-tools
Ein Tool zur Unterstützung des Veröffentlichungsprozesses für Pentaradio-Folgen.
## Installation
Zum Kompilieren und Installieren mittels `make` und `make install` wird ein Go-Compiler benötigt.
Für `pentaradio-tools upload` muss `ftp.c3d2.de` in der ssh-Config eingetragen sein, zum Beispiel:
```
$ cat $HOME/.ssh/config
...
Host ftp.c3d2.de
User ftpupload
Port 2022
IdentityFile /home/username/.ssh/id_ed25519
IdentitiesOnly yes
...
```
## Benutzung
Es gibt zwei Unterbefehle, jeweils ohne Argumente:
* `pentaradio-tools upload` lädt alle relevanten Dateien (Audios, Shownotes, Kapitelmarken) nach `ftp.c3d2.de` hoch.
* `pentaradio-tools generate` generiert die XML-Datei für den Eintrag in [c3d2-web](/c3d2/c3d2-web).
Beide Befehle erwarten die folgenden Dateien im Arbeitsverzeichnis:
```
pentaradio-YYYY-MM-DD.m4a
pentaradio-YYYY-MM-DD.mp3
pentaradio-YYYY-MM-DD.ogg
pentaradio-YYYY-MM-DD.opus
chapter-pentaradio-YYYY-MM-DD.dat
shownotes-pentaradio-YYYY-MM-DD.txt
```
Das Datum muss in allen relevanten Dateien identisch sein.
Die Kapitelmarken-Datei muss dieselben Marken enthalten, die auch in Auphonic eingetragen wurden. Idealerweise hat man die Kapitelmarken-Datei direkt beim Schneiden gefüllt und kann sie dann direkt in Auphonic importieren.
Die Shownotes-Datei enthält die Inhalte des Shownotes-Pads (ist also eigentlich eine Markdown-Datei, nicht eine Textdatei, aber aus historischen Gründen haben wir `.txt` als Endung). Die Shownotes werden in folgendem Format erwartet:
```
# Pentaradio vom DD. Mmm YYYY
# Titel: "<titel>"
<kurzbeschreibung>
## News
...
```
Titel und Kurzbeschreibung gehen in `pentaradio-tools generate` in den Eintrag für c3d2-web ein.