From 8cd5292b937e9e947644e1f50f00abf44e6394d5 Mon Sep 17 00:00:00 2001 From: Stefan Majewsky Date: Thu, 21 Apr 2022 22:08:26 +0200 Subject: [PATCH] translate README to English Let's be real, writing technical docs in German is seriously weird. --- README.md | 32 ++++++++++++++++++-------------- 1 file changed, 18 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index a4b49ca..b230eab 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ # pentaradio-tools -Ein Tool zur Unterstützung des Veröffentlichungsprozesses für Pentaradio-Folgen. +A tool to automate parts of the publishing process of Pentaradio episodes. ## Installation -Zum Kompilieren und Installieren mittels `make` und `make install` wird ein Go-Compiler benötigt. +Compile and install with `make` and `make install`. A Go compiler is required. -Für `pentaradio-tools upload` muss `ftp.c3d2.de` in der ssh-Config eingetragen sein, zum Beispiel: +For the `pentaradio-tools upload` subcommand, `ftp.c3d2.de` must be configured in the SSH client config, for example: ``` $ cat $HOME/.ssh/config @@ -19,14 +19,14 @@ Host ftp.c3d2.de ... ``` -## Benutzung +## Usage -Es gibt zwei Unterbefehle, jeweils ohne Argumente: +There are two subcommands, both without any additional arguments or options: -* `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). +* `pentaradio-tools upload` uploads all relevant files (audios, chapter marks file, shownotes file) to `ftp.c3d2.de`. +* `pentaradio-tools generate` generates an XML file containing a news entry for [c3d2-web](/c3d2/c3d2-web). -Beide Befehle erwarten die folgenden Dateien im Arbeitsverzeichnis: +Both subcommands expect the following files in the working directory: ``` pentaradio-YYYY-MM-DD.m4a @@ -37,20 +37,24 @@ chapter-pentaradio-YYYY-MM-DD.dat shownotes-pentaradio-YYYY-MM-DD.txt ``` -Das Datum muss in allen relevanten Dateien identisch sein. +The date must be identical on all files. -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. +The chapter marks file must contain the same marks that have been given to Auphonic. The usual process is to write the +chapter marks file during editing and then give it to Auphonic's file importer. -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: +The shownotes file must contain the contents of the shownotes pad. It is technically a Markdown file, but for historical +reasons we are using the `.txt` extension. The shownotes must be in the following format: ``` # Pentaradio vom DD. Mmm YYYY -# Titel: "" +# Titel: "" -<kurzbeschreibung> +Mit <author-names>. + +<short-description> ## News ... ``` -Titel und Kurzbeschreibung gehen in `pentaradio-tools generate` in den Eintrag für c3d2-web ein. +The title, author names, and short description are used for the c3d2-web news entry.