diff --git a/theodolite-benchmarks/README.md b/theodolite-benchmarks/README.md index d2a69992637cc8621d26653e78a38a6f9a6f55e1..3764537229e752293aa70ffecfc95df770952ec8 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: