From 86df1650fd0f0e1a5bb8cdff305c2b487acc3541 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=B6ren=20Henning?= <soeren.henning@email.uni-kiel.de>
Date: Tue, 4 Jan 2022 11:36:05 +0100
Subject: [PATCH] Add Readme for building and packaging benchmarks

---
 theodolite-benchmarks/README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 theodolite-benchmarks/README.md

diff --git a/theodolite-benchmarks/README.md b/theodolite-benchmarks/README.md
new file mode 100644
index 000000000..f794d2018
--- /dev/null
+++ b/theodolite-benchmarks/README.md
@@ -0,0 +1,23 @@
+# Theodolite Benchmarks
+
+Theodolite comes with a set of 4 benchmarks for event-driven microservices, which are implemented with Kafka Streams
+and Apache Flink. The benchmarks are based on typical use cases for stream processing and named: UC1, UC2, UC3 and UC4.
+
+## Building and packaging the benchmarks
+
+All benchmarks can be built with:
+
+```sh
+./gradlew build
+```
+
+This produces `.tar` files in `<benchmark-impl>/build/distribution`, where `<benchmark-impl>` is for example
+`uc1-kstreams`.
+
+## Building Docker images of the benchmarks
+
+Each benchmark implementation directory contains a Dockerfile. To build an image (in this case of `uc1-kstreams`), run:
+
+```sh
+docker build -t theodolite-uc1-kstreams ./uc1-kstreams
+```
-- 
GitLab