document config.conf

README.md

@@ -13,35 +13,15 @@ The translation is unidirectional. Words written in the translated version are n
 ```
 git clone https://gitlab.fem-net.de/technik/protocol-translation-live.git
 cd protocol-translation-live
+cp example.conf config.conf
 ```
 Now edit `config.conf` to fit your needs. An example configuration file could look like:
 
-> TODO: proper documentation of the example config file
-```
-[main]
-active_set_size = 3
-
-[translation]
-service = libretranslate
-service_url = https://translate.fem-net.de
-
-[source]
-kind = hedgedoc
-url = https://collab.fem-net.de/md/translation-test-source
-language = de
-
-[destination]
-kind = etherpad
-url = https://collab.fem-net.de/pad/p/translation-test-destination
-language = en
-```
-The `active_set` is the part of the text in the source protocol which is to be translated. If the whole protocol text where the active set the required computing power would be too high. Therefore it is assumed that only the lower part of the protocol is changing so every loop run the last `active_set_size` lines are translated.
-
 > Currently it is only possible for the destination to be an etherpad instance. The source could be either a hedgedoc or an etherpad instance.
 
 > The pads themselves have to exist before you start the package
 
-Then create a file named `api_keys.conf` using the template below and enter the API-Keys of the services you want to use.
+Then, create a file named `api_keys.conf` using the template below and enter the API-Keys of the services you want to use.
 ```
 [default]
 etherpad_key = <etherpad-key>

example.conf

 [main]
+# number of lines (counted from 1st line) that are not to be translated
+# useful, e.g. if there is ascii art at the top of the protocol
+# which would be destroyed by translation
 header_size = 0 
 
 [translation]
+# possible values: libretranslate
 service = libretranslate
 service_url = https://translate.fem-net.de
 
 [source]
+# possible values: etherpad, hedgedoc
 kind = etherpad
 url = https://collab.fem-net.de/pad/p/translation-test-source
+# possible values:
+# every language tag that is supported by the translation service
 language = de
 
 [destination]
+# possible values: etherpad
 kind = etherpad
 url = https://collab.fem-net.de/pad/p/translation-test-destination
+# possible values:
+# every language tag that is supported by the translation service
 language = en
\ No newline at end of file