From 60c0f23ad2dbf373d94cf3abf007d3374b1ecbca Mon Sep 17 00:00:00 2001
From: Stefan Hynek <stefan.hynek@uni-goettingen.de>
Date: Thu, 24 Feb 2022 15:28:54 +0100
Subject: [PATCH] docs(readme): explain tgclients library integration in local
 and docker setup

resolves https://gitlab.gwdg.de/dariah-de/textgridrep/repdav/-/merge_requests/15#note_592925
---
 README.md | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/README.md b/README.md
index df7cd12..5561330 100644
--- a/README.md
+++ b/README.md
@@ -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:
-- 
GitLab