From 8520a8e073f9f045501a04e2ea5b0058f14b0eaa Mon Sep 17 00:00:00 2001
From: Marcel Auer <marcel.auer@kit.edu>
Date: Wed, 12 Jun 2024 14:34:21 +0000
Subject: [PATCH] added mermaid graph
---
README.md | 38 ++++++++++++++++++++++++++++++++++++++
1 file changed, 38 insertions(+)
diff --git a/README.md b/README.md
index 3f570e2..d64d0c6 100644
--- a/README.md
+++ b/README.md
@@ -23,6 +23,10 @@ Die resultierenden Standings, Tabellen, Statistiken sollen von Ihrer Software ge
Zusätzlich soll Ihre Software Statistiken generieren, wie hoch die Siegwahrscheinlichkeit eines/r Sportler*in oder eines Teams auf Basis des Verlaufs ist.
+Diese Aufgabenstellung ist bewusst etwas offener gestaltet, um Ihnen Gegstaltungsfreiraum zu gewähren:
+- Erstellen Sie ein Konzept
+-
+
## Anforderungen
- Saubere Nutzung von git (branching, commit messages, merging) in einem private Repository auf der KIT GitLab Instanz mit dem Namen "ITAT_Challenge_2024_<Projektname>"
- Arbeit in einer Gruppe von bis zu 3 Personen ist erlaubt
@@ -52,6 +56,40 @@ UML Klassendiagramme können sehr einfach z.B. mit DrawIO oder Papyrus erstellt
<img src="img/UML.png" alt="uml" width="500"/>
+Oder alternativ direkt in Markdown mit Mermaid:
+
+```mermaid
+classDiagram;
+ class Person {
+ -name: String
+ -geld: double
+ +Person(pName: String)
+ +geldErhoehen(pBetrag: double)
+ +geldVermindern(pBetrag: double): boolean
+ +fahren(pKm: double): boolean
+ +tanken(pLiter: double): boolean
+ +setTankstelle(pTankstelle: Tankstelle)
+ };
+ class Tankstelle {
+ -preisProLiter: double
+ -name: String
+ +Tankstelle(pName: String)
+ +setPreis(pPreis: double)
+ +getPreis(): double
+ +tanken(pLiter: double): double
+ };
+ class Roller {
+ -kmStand: double
+ -tankInhalt: double
+ -maxTank: double
+ +Roller()
+ +fahren(pKm: double): boolean
+ +tanken(pLiter: double): boolean
+ };
+ Person -- Roller : meinRoller;
+ Person -- Tankstelle : die Tankstelle;
+```
+
## Projekt-Dokumentation
Beschreiben Sie hier, wie ihre Software zu nutzen ist.
- Wie erfolgen die Eingaben?
--
GitLab