daniel/ReadFeeder
1
0
Fork 0
Code Issues 2 Pull requests Projects Releases Packages Wiki Activity

small fixes to README

Browse source
This commit is contained in:
Daniel Spittank 2023-11-06 00:20:51 +01:00
parent d0a08c9880
commit 2828cbff91
2 changed files with 14 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -13,7 +13,7 @@ Dieses Skript lädt einen RSS-Feed und erstellt für neue und geänderte Einträ
Die Konfiguration muss immer vollständig sein, es finden keinerlei Überprüfungen statt. Fehlende Konfigurationsparameter führen zu Programmfehlern. Die Konfiguration muss immer vollständig sein, es finden keinerlei Überprüfungen statt. Fehlende Konfigurationsparameter führen zu Programmfehlern.
### Elevenlabs ### Elevenlabs
``` ```yaml
elevenlabs: elevenlabs:
enabled: false enabled: false
api_key: <CHANGE_ME> api_key: <CHANGE_ME>
@ -29,7 +29,7 @@ Soll für die Generierung [ElevenLabs](https://elevenlabs.io/) verwendet werden,
### Audio ### Audio
``` ```yaml
audio: audio:
artist: ReadFeeder artist: ReadFeeder
``` ```
@ -37,7 +37,7 @@ audio:
In diesem Abschnitt können Teile der Metadaten für die generierten Audiodateien angegeben werden, aktuell der ```artist```. In diesem Abschnitt können Teile der Metadaten für die generierten Audiodateien angegeben werden, aktuell der ```artist```.
### Mastodon ### Mastodon
``` ```yaml
mastodon: mastodon:
enabled: true enabled: true
instance_url: <CHANGE_ME> instance_url: <CHANGE_ME>
@ -59,7 +59,7 @@ Die ```visibility``` legt fest, wer die Postings lesen kann:
Unter ```post``` kann für jeden Bestandteil festgelegt werden, ob er im Post erscheinen soll. ACHTUNG: Es wird aktuell keine Größenkontrolle durchgeführt. Daher ist es sicherer, nicht den Text oder gar nichts (dann wird nur die generierte Datei gepostet) einzustellen. Unter ```post``` kann für jeden Bestandteil festgelegt werden, ob er im Post erscheinen soll. ACHTUNG: Es wird aktuell keine Größenkontrolle durchgeführt. Daher ist es sicherer, nicht den Text oder gar nichts (dann wird nur die generierte Datei gepostet) einzustellen.
### RSS ### RSS
``` ```yaml
rss: rss:
feed_url: <CHANGE_ME> feed_url: <CHANGE_ME>
use_field: title use_field: title
@ -68,7 +68,7 @@ rss:
In diesem Abschnitt müssen die Feedadresse (```feed_url```) und das zu verwendende Feld (```use_field```) angegeben werden. Das Feld kann z.B. ```title``` oder ```description``` sein. Der Volltext eines Artikels steht meist in ```description```, aber manche Feeds haben auch nur einen Titel. In diesem Abschnitt müssen die Feedadresse (```feed_url```) und das zu verwendende Feld (```use_field```) angegeben werden. Das Feld kann z.B. ```title``` oder ```description``` sein. Der Volltext eines Artikels steht meist in ```description```, aber manche Feeds haben auch nur einen Titel.
### Sprachen ### Sprachen
``` ```yaml
languages: languages:
default: en default: en
used: used:
@ -84,14 +84,14 @@ Mit den Sprachen unter ```used``` legt man eine Auswahl der Sprachen fest, die i
Da nicht alle Begriffe sauber generiert werden können (oder sollen), werden auf die Inhalte zwei Arten von Filtern angewendet. Da nicht alle Begriffe sauber generiert werden können (oder sollen), werden auf die Inhalte zwei Arten von Filtern angewendet.
#### Wortfilter #### Wortfilter
``` ```yaml
word_filter: word_filter:
"...": "…" "...": "…"
``` ```
Wortfilter erlauben einfache Ersetzungen nach dem Muster ```"original": "replacement"```. Wortfilter erlauben einfache Ersetzungen nach dem Muster ```"original": "replacement"```.
#### RegEx-Filter #### RegEx-Filter
``` ```yaml
regex_filter: regex_filter:
"[tT]est": "Test" "[tT]est": "Test"
``` ```

14
README_en.md
View file

@ -13,7 +13,7 @@ This script loads an RSS feed and creates an audio file via TTS for new and chan
The configuration must always be complete, no checks are carried out. Missing configuration parameters will cause program errors. The configuration must always be complete, no checks are carried out. Missing configuration parameters will cause program errors.
### Elevenlabs ### Elevenlabs
``` ```yaml
elevenlabs: elevenlabs:
enabled: false enabled: false
api_key: <CHANGE_ME> api_key: <CHANGE_ME>
@ -28,7 +28,7 @@ elevenlabs:
If [ElevenLabs](https://elevenlabs.io/) should be used for generation, it has to be activated with ```enabled: true```. Otherwise gTTS will be used. In this case, an ```api_key``` has to be set, additionally a language and its settings can be specified. By default "Patrick" is set. If [ElevenLabs](https://elevenlabs.io/) should be used for generation, it has to be activated with ```enabled: true```. Otherwise gTTS will be used. In this case, an ```api_key``` has to be set, additionally a language and its settings can be specified. By default "Patrick" is set.
### Audio ### Audio
``` ```yaml
audio: audio:
artist: ReadFeeder artist: ReadFeeder
``` ```
@ -36,7 +36,7 @@ audio:
In this section, parts of the metadata for the generated audio files can be specified, currently the ```artist```. In this section, parts of the metadata for the generated audio files can be specified, currently the ```artist```.
### Mastodon ### Mastodon
``` ```yaml
mastodon: mastodon:
enabled: true enabled: true
instance_url: <CHANGE_ME> instance_url: <CHANGE_ME>
@ -58,7 +58,7 @@ The ```visibility``` determines who can read the postings:
Under ```post```, it can be determined for each component whether it should appear in the post. WARNING: Currently, no size control is carried out. Therefore, it is safer to not set the text or nothing at all (then only the generated file will be posted). Under ```post```, it can be determined for each component whether it should appear in the post. WARNING: Currently, no size control is carried out. Therefore, it is safer to not set the text or nothing at all (then only the generated file will be posted).
### RSS ### RSS
``` ```yaml
rss: rss:
feed_url: <CHANGE_ME> feed_url: <CHANGE_ME>
use_field: title use_field: title
@ -67,7 +67,7 @@ rss:
In this section, the feed address (`feed_url`) and the field to be used (`use_field`) must be specified. The field can be, for example, ```title``` or ```description```. The full text of an article is usually in ```description```, but some feeds only publish a title. In this section, the feed address (`feed_url`) and the field to be used (`use_field`) must be specified. The field can be, for example, ```title``` or ```description```. The full text of an article is usually in ```description```, but some feeds only publish a title.
### Languages ### Languages
``` ```yaml
languages: languages:
default: en default: en
used: used:
@ -83,14 +83,14 @@ With the languages under ```used```, you define a selection of languages that ca
Since not all terms can (or should) be generated, two types of filters are applied to the contents. Since not all terms can (or should) be generated, two types of filters are applied to the contents.
#### Word filter #### Word filter
``` ```yaml
word_filter: word_filter:
"...": "..." "...": "..."
``` ```
Word filters allow simple replacements according to the pattern ```"original": "replacement"```. Word filters allow simple replacements according to the pattern ```"original": "replacement"```.
#### RegEx filter #### RegEx filter
``` ```yaml
regex_filter: regex_filter:
"[tT]est": "Test" "[tT]est": "Test"
``` ```