Commit 5b88f3e5 authored by Jakob Lerch's avatar Jakob Lerch
Browse files

extend readme

parent bbda1461
......@@ -11,16 +11,40 @@ The translation is unidirectional. Words written in the translated version are n
## Usage
```
git clone ...
cd ...
git clone https://gitlab.fem-net.de/technik/protocol-translation-live.git
cd protocol-translation-live
```
Now edit config.conf to fit your needs. An example configuration file could look like:
Now edit `config.conf` to fit your needs. An example configuration file could look like:
```
...
[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
```
> currently it is only possible for the destination to be an etherpad instance. The source could be either a hedgedoc or an etherpad instance.
Then execute the script as a module
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>
libretranslate_key = <libretranslate-key>
```
After that install the package by typing
```
python3 setup.py install
```
Now you can execute the package by typing
```
python3 -m ...
python3 protocol_translation_live
```
\ No newline at end of file
......@@ -3,11 +3,11 @@ service=libretranslate
service_url=https://translate.fem-net.de
[source]
kind = etherpad
url = https://collab.fem-net.de/pad/p/lulz1
kind = hedgedoc
url = https://collab.fem-net.de/md/ttp
language = de
[destination]
kind = etherpad
url = https://collab.fem-net.de/pad/p/test2
url = https://collab.fem-net.de/pad/p/translation-test-destination
language = en
\ No newline at end of file
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment