Skip to content
Snippets Groups Projects
Verified Commit 60c0f23a authored by Stefan Hynek's avatar Stefan Hynek :drooling_face:
Browse files

docs(readme): explain tgclients library integration in local and docker setup

parent 343e0be8
No related branches found
No related tags found
1 merge request!15Resolve "init reuse"
Pipeline #277995 passed
......@@ -37,12 +37,19 @@ SPDX-License-Identifier: CC0-1.0
python src/main.py
```
-----
Attention: This setup assumes you have the tgclients library source code installed at `../tgclients/`; see the [development requirements](requirements.dev.txt).
-----
For your convenience, a Docker Compose setup is delivered with this repository that configures the service accordingly. Build and start the stack.
```sh
docker-compose up --build
```
This setup does not rely on a local installation of the tgclients library but instead installs the (supposedly) latest and tested compatible version of the library; see the [requirements](requirements.txt).
## Contributing
Commit convention:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment