From 94068153a54de288f1ef09ce0721c89a544d1529 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=B6ren=20Henning?= <soeren.henning@email.uni-kiel.de>
Date: Mon, 5 Dec 2022 16:23:03 +0100
Subject: [PATCH] Improve benchmarks readme

---
 theodolite-benchmarks/README.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/theodolite-benchmarks/README.md b/theodolite-benchmarks/README.md
index d2a699926..376453722 100644
--- a/theodolite-benchmarks/README.md
+++ b/theodolite-benchmarks/README.md
@@ -4,6 +4,16 @@ Theodolite comes with a set of 4 benchmarks for event-driven microservices, whic
 The benchmarks are based on typical use cases for stream processing and named: UC1, UC2, UC3 and UC4.
 Additionally, we include a load generator for each benchmark.
 
+## Project organization
+
+All benchmark implementations are organized in a Gradle multi-project. See the [`settings.gradle`](settings.gradle) file for an overview of subprojects and how they are organized.
+We also use Gradle convention plugins, organized in [`buildSrc`](buildSrc), for sharing build configuration among subprojects.
+
+Additionally, this directory contains:
+
+* *Theodolite* Benchmark definitions for all benchmarks in [`definitions`](definitions).
+* Docker Compose files to assist in local development and to run smoke tests in [`docker-test`](docker-test).
+
 ## Building and packaging the benchmarks
 
 All benchmarks can be built with:
-- 
GitLab