From 70a249b93fab1f5dd54c1a52fd5b35733b5a7786 Mon Sep 17 00:00:00 2001
From: Alexander Rudolph <alexander06@mi.fu-berlin.de>
Date: Sat, 16 Mar 2024 00:01:04 +0100
Subject: [PATCH] Add README

---
 README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a2d9d86
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# Evaluation Report Generator
+
+This project corresponds to the bachelor's thesis "Creating a Pipeline for Reproducible Evaluation Report Generation" written at the Human-Centered Computing research group.
+First Examiner: Prof. Dr. Claudia Müller-Birn
+Second Examiner: TBA
+
+## Description
+
+This repository contains two pipelines `pipeline.ipynb` and `new_pipeline.ipynb` which generate evaluation reports. `pipeline.ipynb` automates the current evaluation report, while `new_pipeline.ipynb` uses suggestions from different people across the department for Mathematics, Computer Science and Bioinformatics to improve the evaluation report.
+To work the pipeline needs data in the `raw_data/` folder in the following structure:
+
+```shell
+├── Bioinformatik
+│   └── Bioinformatik_SoSe2019
+│       └── daten.csv
+├── Informatik
+│   └── Informatik_SoSe2019
+│       └── daten.csv
+└── Mathematik
+    └── Mathematik_SoSe2019
+        └── daten.csv
+```
+
+`daten.csv` comes from an export in [Zensus](https://www.zedat.fu-berlin.de/Benutzerservice/UniZensus). The `data.example.csv` shows the schema the data needs to have. To be able to work the pipeline also needs data for all three institutes per semester. Folders with semester names should always look like this: `[Institute]_[WiSeYYYY/YY|SoSeYYYY]`.
-- 
GitLab