From 9163b480d9bbdd4093215dcb2e94aec1efcd2ffa Mon Sep 17 00:00:00 2001
From: Benno Lang <transmogribenno@gmail.com>
Date: Thu, 23 Jan 2025 16:37:16 +1030
Subject: [PATCH] Add README

---
 README.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 56 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1a27aa1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,56 @@
+# Podkastomat
+
+🧰 A tool for automatically downloading and transcribing podcasts, with the option to translate them into English.
+
+📚 Built for language learners.
+
+## Usage
+
+To add a podcast:
+
+```sh
+./update-config add
+```
+
+This will ask you for the name, language code, and the RSS URL of the podcast, as well as whether you want the main process to automatically download the latest episode of this podcast when it runs.
+
+To configure translating podcasts from a given language - in this example, German - into English (without this step, podcasts will be transcribed but not translated).
+
+```sh
+./update-config translate de
+```
+
+To process all configured podcasts
+
+```sh
+./process
+```
+
+To fetch and process the earliest 3 episodes of a particular podcast
+
+```sh
+./process 'some podcast' old 3
+```
+
+Online help for additional options is available via `./process --help`
+
+Downloaded episodes, and generated transcripts and translations, will be stored in `podcasts/{language}/{podcast_name}`.
+E.g.: `podcasts/de/mission_klima_-_lösungen_für_die_krise`
+
+## Manual configuration
+
+Feel free to edit the `config.json` file
+
+## System Requirements
+
+* Linux (but it probably works on other platforms 🤷)
+* Python 3 (tested on 3.8.10)
+* One or both of the following:
+  * [Whisper](https://github.com/openai/whisper/) (supports transcripts and translations)
+  * [Vosk](https://alphacephei.com/vosk/install#python-installation-from-pypi) (supports transcripts)
+* [Mutagen](https://pypi.org/project/mutagen/)
+
+## Notes
+
+Whisper (used by default for transcriptions and translations) is quite slow and resource intensive.  
+It may be worth running the `process` script overnight, e.g. as a cron job.