small fixes to README
This commit is contained in:
parent
d0a08c9880
commit
2828cbff91
2 changed files with 14 additions and 14 deletions
14
README.md
14
README.md
|
|
@ -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.
|
||||
|
||||
### Elevenlabs
|
||||
```
|
||||
```yaml
|
||||
elevenlabs:
|
||||
enabled: false
|
||||
api_key: <CHANGE_ME>
|
||||
|
|
@ -29,7 +29,7 @@ Soll für die Generierung [ElevenLabs](https://elevenlabs.io/) verwendet werden,
|
|||
|
||||
|
||||
### Audio
|
||||
```
|
||||
```yaml
|
||||
audio:
|
||||
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```.
|
||||
|
||||
### Mastodon
|
||||
```
|
||||
```yaml
|
||||
mastodon:
|
||||
enabled: true
|
||||
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.
|
||||
|
||||
### RSS
|
||||
```
|
||||
```yaml
|
||||
rss:
|
||||
feed_url: <CHANGE_ME>
|
||||
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.
|
||||
|
||||
### Sprachen
|
||||
```
|
||||
```yaml
|
||||
languages:
|
||||
default: en
|
||||
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.
|
||||
|
||||
#### Wortfilter
|
||||
```
|
||||
```yaml
|
||||
word_filter:
|
||||
"...": "…"
|
||||
```
|
||||
Wortfilter erlauben einfache Ersetzungen nach dem Muster ```"original": "replacement"```.
|
||||
|
||||
#### RegEx-Filter
|
||||
```
|
||||
```yaml
|
||||
regex_filter:
|
||||
"[tT]est": "Test"
|
||||
```
|
||||
|
|
|
|||
14
README_en.md
14
README_en.md
|
|
@ -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.
|
||||
|
||||
### Elevenlabs
|
||||
```
|
||||
```yaml
|
||||
elevenlabs:
|
||||
enabled: false
|
||||
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.
|
||||
|
||||
### Audio
|
||||
```
|
||||
```yaml
|
||||
audio:
|
||||
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```.
|
||||
|
||||
### Mastodon
|
||||
```
|
||||
```yaml
|
||||
mastodon:
|
||||
enabled: true
|
||||
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).
|
||||
|
||||
### RSS
|
||||
```
|
||||
```yaml
|
||||
rss:
|
||||
feed_url: <CHANGE_ME>
|
||||
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.
|
||||
|
||||
### Languages
|
||||
```
|
||||
```yaml
|
||||
languages:
|
||||
default: en
|
||||
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.
|
||||
|
||||
#### Word filter
|
||||
```
|
||||
```yaml
|
||||
word_filter:
|
||||
"...": "..."
|
||||
```
|
||||
Word filters allow simple replacements according to the pattern ```"original": "replacement"```.
|
||||
|
||||
#### RegEx filter
|
||||
```
|
||||
```yaml
|
||||
regex_filter:
|
||||
"[tT]est": "Test"
|
||||
```
|
||||
|
|
|
|||
Loading…
Reference in a new issue