# SE2-Projekt: Beispiel einer Readme.md

## Format der Dokumentation
Bitte halten Sie sich kurz und beschreiben Sie die wichtigsten Eigenschaften ihres Projekts.

## Metadaten

* Projektname: *Ihre Benennung in Idea*
* Titelblatt: *Autor:innen mit Kürzeln*
* Pfad zum Repository, wichtige Infos (z.B. das Projekt verwendet eine externe Datenbank)

## Start

* Abstract: Kurzbeschreibung des Projekts. Um was gehts?
* Startklasse: In welcher Klasse befindet sich die `main()`-Methode
* Besonderheiten: Teile, die nicht funktionieren

## UML
UML-Klassendiagramm, UML Use-Case-Diagramm (Diagramme müssen auch im Repository abgelegt werden)

![UML-Diagramm](img/ReadmeUML-Example.png)


## Stellungnahmen
Kurze Beschreibungen wie die Bewertungskategorien implementiert wurden (z.B.
Logging-Strategie). Zusätzlich ein Hinweis in welcher/welchen Klasse/n die Funktionalität
implementiert wurde z.B.:

* OOP-Architektur
* Clean Code
* Doku
* Tests
* GUI
* Logging/Exceptions
* UML
* Threads
* Streams

## Bewertungsbogen – Teamübersicht (Beispiel) 

| ID | Vorname | Nachname | Kürzel | Matrikelnummer | OOP-Architektur (%) | Clean Code (%) | Doku (%) | Tests (%) | GUI (%) | Logging (%) | UML (%) | Threads (%) | Streams (%) |
|----|---------|----------|--------|----------------|---------------------|---------------|----------|-----------|---------|--------------|---------|-------------|-------------|
| 1  | Anna    | Müller   | am123  | 12345678       | 30                  | 20            | 10       | 10        | 20      | 10           | 0       | 0           | 0           |
| 2  | Lukas   | Schneider| ls123  | 23456789       | 20                  | 20            | 0        | 20        | 0       | 10           | 0       | 20          | 10          |
| 3  | Sarah   | Weber    | sw123  | 34567890       | 10                  | 20            | 20       | 10        | 10      | 0            | 20      | 0           | 10          |