From e80c1effc51b249848e6e36fecd5fca37ace4f4d Mon Sep 17 00:00:00 2001
From: Marcel Auer <marcel.auer@kit.edu>
Date: Wed, 12 Jun 2024 06:59:04 +0000
Subject: [PATCH] Update README.md

---
 .gitignore                                    |  36 ++++++++++++++++++
 README.md                                     |  22 ++++++++---
 .../UML.png                                   | Bin
 src/main.cpp                                  |   5 +++
 4 files changed, 57 insertions(+), 6 deletions(-)
 create mode 100644 .gitignore
 rename Klassendiagramm-Roller-Tankstelle.png => img/UML.png (100%)
 create mode 100644 src/main.cpp

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..20edb1d
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,36 @@
+# CLion project files
+.idea
+cmake-build-*
+
+# Prerequisites
+*.d
+
+# Compiled Object files
+*.slo
+*.lo
+*.o
+*.obj
+
+# Precompiled Headers
+*.gch
+*.pch
+
+# Compiled Dynamic libraries
+*.so
+*.dylib
+*.dll
+
+# Fortran module files
+*.mod
+*.smod
+
+# Compiled Static libraries
+*.lai
+*.la
+*.a
+*.lib
+
+# Executables
+*.exe
+*.out
+*.app
\ No newline at end of file
diff --git a/README.md b/README.md
index 562eb06..8f3060f 100644
--- a/README.md
+++ b/README.md
@@ -23,7 +23,7 @@ Zusätzlich soll Ihre Software Statistiken generieren, wie hoch die Siegwahrsche
 - 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
 - Das Programm muss für die Prüfer kompilierbar sein ohne zusätzliche Hardware- oder Softwareanforderungen (also keine Einbindung von Bibliotheken, die zusätzlich installiert werden müssten)
-  - Ausnahme ist die Nutzung von Qt6 als Framework zur Erstellung einer grafischen Benutzeroberfläche (graphical user interface, GUI), falls das gewünscht ist
+  - Ausnahme ist die Nutzung von [Qt6](https://wiki.qt.io/Einstieg_in_die_Programmierung_mit_Qt6) als Framework zur Erstellung einer grafischen Benutzeroberfläche (graphical user interface, GUI), falls das gewünscht ist
   - ansonsten nur die C++ Standard Libraries 
   - C++17
   - g++ Compiler
@@ -39,9 +39,19 @@ Zusätzlich soll Ihre Software Statistiken generieren, wie hoch die Siegwahrsche
 
 ## Teilnahme
 
-Fügen Sie Marcel Auer (marcel.auer) und Marwin Madsen (marwin.madsen) bis **28.06.2024** zu ihrem Repository hinzu. 
-Erstellen Sie in ihrem Repository bis zum **16.08.2024** einen Release, der mit __Abgabe__ getagt ist (nur dieser Release wird betrachtet).
+1. Fügen Sie Marcel Auer (marcel.auer) und Marwin Madsen (marwin.madsen) bis **28.06.2024** zu ihrem Repository hinzu. 
+2. Erstellen Sie in ihrem Repository bis zum **16.08.2024** einen Release, der mit __Abgabe__ getagt ist (nur der Stand zum Release wird betrachtet).
 
-### Beispiel: UML Klassendiagramm
-kann z.B. mit DrawIO oder Papyrus erstellt werden: 
-<img src="Klassendiagramm-Roller-Tankstelle.png" alt="uml" width="500"/>
\ No newline at end of file
+# Beispiel: 
+
+## UML Klassendiagramm
+UML Klassendiagramme können sehr einfach z.B. mit DrawIO oder Papyrus erstellt werden: 
+<img src="img/UML.png" alt="uml" width="500"/>
+
+## Projekt-Dokumentation
+Beschreiben Sie hier, wie ihre Software zu nutzen ist. 
+- Wie erfolgen die Eingaben?
+- Für statistische Auswertung der Ergebnisse: Wie erfolgt die Berechung?
+- Wie könnte ihr Projekt noch erweitert werden?
+
+Als Inspriation: [Mermaid - Github](https://github.com/mermaid-js/mermaid)
diff --git a/Klassendiagramm-Roller-Tankstelle.png b/img/UML.png
similarity index 100%
rename from Klassendiagramm-Roller-Tankstelle.png
rename to img/UML.png
diff --git a/src/main.cpp b/src/main.cpp
new file mode 100644
index 0000000..9dfcdb6
--- /dev/null
+++ b/src/main.cpp
@@ -0,0 +1,5 @@
+/* 
+
+Place your code in the /src directory
+
+*/
\ No newline at end of file
-- 
GitLab