From 02f8165dc713b491e9410387db441a4e0a94c389 Mon Sep 17 00:00:00 2001
From: Stefan Hynek <stefan.hynek@uni-goettingen.de>
Date: Thu, 21 Oct 2021 14:13:11 +0200
Subject: [PATCH] docs(readme): describe development and contributing

---
 README.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 51 insertions(+)

diff --git a/README.md b/README.md
index a9e1487..45c65f3 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,53 @@
 # repdav
 
+## Development
+
+1. Prerequisites
+    - Python 3.8
+    - Docker 20.10
+    - Docker Compose 1.25
+1. Create/activate virtual environment (ensure you use the correct python version!).
+
+    ```sh
+    python -m venv venv
+    . venv/bin/activate
+    ```
+
+1. Install requirements.
+
+    ```sh
+    pip install $(cat requirements.txt requirements.dev.txt)
+    ```
+
+1. Configure the service by setting the following variables either in your environment or in the `docker-compose.yml` file.
+    - host
+    - port
+    - tg_auth_wsdl
+    - tg_auth_address
+
+1. Start the service.
+
+    ```sh
+    python main.py
+    ```
+
+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
+```
+
+## Contributing
+
+Commit convention:
+
+- Use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/)
+
+Style constraints:
+
+- Code: [PEP 8](https://www.python.org/dev/peps/pep-0008/)
+- Documentation: [PEP 287](https://www.python.org/dev/peps/pep-0287/)
+
+Coding constraints:
+
+- Objects that are not supposed to be used outside the current scope MUST be named starting with `_` (underscore): [PEP 316](https://www.python.org/dev/peps/pep-0316/#id12)
-- 
GitLab