From 5b55b7f9c4adb0be864844a831b95d55e89a4d87 Mon Sep 17 00:00:00 2001
From: Frederik <frederik@prasch.de>
Date: Mon, 10 Feb 2025 03:19:34 +0100
Subject: [PATCH] Properly format README and add missing author details for
 Tilemarker

---
 README.md                  | 89 +++++++++++++++++++++++---------------
 src/game/ui/TileMarker.cpp |  6 +++
 src/game/ui/TileMarker.hpp |  6 +++
 3 files changed, 66 insertions(+), 35 deletions(-)

diff --git a/README.md b/README.md
index d103a17..5df4cf3 100644
--- a/README.md
+++ b/README.md
@@ -132,15 +132,20 @@ David Maul:
 
 Frederik Keens:
 
-- main.cpp
-- Player.cpp/hpp
-- Level.cpp/hpp
-- Building.cpp/hpp
-- Unit.cpp/hpp
-- Tile.cpp/hpp
-- Spritesheet.cpp/hpp
-- Scene.hpp
-- Engine.cpp/hpp
+- Rendering of the graphics and scene management
+- Player logic
+- Diverse support in event handling and bugs
+- Merge request last resort
+- Specifics:
+    - main.cpp
+    - Player.cpp/hpp
+    - Level.cpp/hpp
+    - Building.cpp/hpp
+    - Unit.cpp/hpp
+    - Tile.cpp/hpp
+    - Spritesheet.cpp/hpp
+    - Scene.hpp
+    - Engine.cpp/hpp
 
 David Hermann:
 
@@ -171,29 +176,43 @@ Nils Jonathan Friedrich Eckardt:
 
 Jonathan Dueck (committer name TheUltimateOptimist):
 
-Allgemein:  
-- Level Editor 
-- Level Laden und Speichern
-- Level Dateiformat
-- LevelEditor Dokumentation (in documentation ordner)
-
-Spezifisch:  
-- src/editor/EventHandler.cpp/hpp
-- src/editor/LevelNameEdit.cpp/hpp
-- src/editor/LevelScene.hpp/cpp 
-  alles ausser setTile, onTileClicked, placeAdvancedTiles, onAdvancedPlacementToggled,
-  onSymmetryToggled, placeCliff, placeRoad, calcDir, isntIdentical  
-  Die genannten Funktionen hat Nils implementiert um Kacheln automatisch setzen (advanced placement) und symmetrisches placement zu realisieren.
-- src/editor/LevelView.cpp/hpp
-- src/editor/main.cpp
-- src/editor/MainWindow.cpp/hpp Nils und ich beide
-- src/editor/SaveButton.cpp/hpp
-- src/editor/SpriteProvider.cpp/hpp
-- src/editor/Tile.cpp/hpp
-- src/editor/TopBar.cpp/hpp gemeinsam mit Nils
-- src/editor/ZoomInButton.cpp/hpp
-- src/editor/ZoomOutButton.cpp/hpp
-- src/editor/ZoomInfo.cpp/hpp
-- src/editor/ZoomOutButton.cpp/hpp
-- in src/game/main.cpp auch noch getLevelFilePath und ersten block in main methode
-- in src/game/level/Level.cpp im Konstruktor das Laden des Levels
+- Allgemein:  
+    - Level Editor 
+    - Level Laden und Speichern
+    - Level Dateiformat
+    - LevelEditor Dokumentation (in documentation ordner)
+
+- Spezifisch:  
+    - src/editor/EventHandler.cpp/hpp
+    - src/editor/LevelNameEdit.cpp/hpp
+    - src/editor/LevelScene.hpp/cpp 
+    alles ausser setTile, onTileClicked, placeAdvancedTiles, onAdvancedPlacementToggled,
+    onSymmetryToggled, placeCliff, placeRoad, calcDir, isntIdentical  
+    Die genannten Funktionen hat Nils implementiert um Kacheln automatisch setzen (advanced placement) und symmetrisches placement zu realisieren.
+    - src/editor/LevelView.cpp/hpp
+    - src/editor/main.cpp
+    - src/editor/MainWindow.cpp/hpp Nils und ich beide
+    - src/editor/SaveButton.cpp/hpp
+    - src/editor/SpriteProvider.cpp/hpp
+    - src/editor/Tile.cpp/hpp
+    - src/editor/TopBar.cpp/hpp gemeinsam mit Nils
+    - src/editor/ZoomInButton.cpp/hpp
+    - src/editor/ZoomOutButton.cpp/hpp
+    - src/editor/ZoomInfo.cpp/hpp
+    - src/editor/ZoomOutButton.cpp/hpp
+    - in src/game/main.cpp auch noch getLevelFilePath und ersten block in main methode
+    - in src/game/level/Level.cpp im Konstruktor das Laden des Levels
+
+
+Nicolas Will:
+
+- Tilemarker.cpp/hpp
+- UnitInfoMenu.cpp/hpp
+- HelpMenu.cpp/hpp
+- PauseMenu.cpp/hpp
+- Endscreen.cpp/hpp
+- RecruitingMenu.cpp/hpp
+- ContextMenu.cpp/hpp
+- Level.cpp/hpp
+- Unit.cpp/hpp
+- Building.cpp/hpp
diff --git a/src/game/ui/TileMarker.cpp b/src/game/ui/TileMarker.cpp
index 856915c..a1f4870 100644
--- a/src/game/ui/TileMarker.cpp
+++ b/src/game/ui/TileMarker.cpp
@@ -1,3 +1,9 @@
+/**
+ * Tilemarker.cpp
+ *
+ * @author Nicolas Will
+ */
+
 #include "TileMarker.hpp"
 
 #include <iostream>
diff --git a/src/game/ui/TileMarker.hpp b/src/game/ui/TileMarker.hpp
index bac92c4..fe94ce3 100644
--- a/src/game/ui/TileMarker.hpp
+++ b/src/game/ui/TileMarker.hpp
@@ -1,3 +1,9 @@
+/**
+ * Tilemarker.hpp
+ *
+ * @author Nicolas Will
+ */
+
 #pragma once
 
 #include "../core/Scene.hpp"
-- 
GitLab