From 111e95857ac8ba4bcd4fc5198b307217823c116f Mon Sep 17 00:00:00 2001 From: Marcel Auer <marcel.auer@kit.edu> Date: Wed, 12 Jun 2024 13:37:02 +0000 Subject: [PATCH] added Chapter about gitignore to README.md --- README.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 0360602..1b69e18 100644 --- a/README.md +++ b/README.md @@ -40,10 +40,9 @@ Zusätzlich soll Ihre Software Statistiken generieren, wie hoch die Siegwahrsche ## Teilnahme 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: +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). Nähere Infos zum Erstellen von Releases: [GitLab - Releases](https://docs.gitlab.com/ee/user/project/releases/) +# Beispiele und Hinweise: ## UML Klassendiagramm UML Klassendiagramme können sehr einfach z.B. mit DrawIO oder Papyrus erstellt werden: @@ -56,3 +55,11 @@ Beschreiben Sie hier, wie ihre Software zu nutzen ist. - Wie könnte ihr Projekt noch erweitert werden? Als Inspriation: [Mermaid - Github](https://github.com/mermaid-js/mermaid) + +## .gitignore +In diesem Repository ist eine Datei mit dem Namen ___.gitignore___ hinterlegt. Wir raten ihnen diese Datei in der obersten Ebene (dort, wo auch README.md liegt) ihrem Projekt hinzuzufügen. + +Die in dieser Datei aufgelisteten Dateiformate werden dann von Git nicht mehr beachtet. Das verhindert, dass Dateien getrackt werden, welche automatisch beim Kompilieren erstellt werden und in ihrem Repository keinen Mehrwert darstellen würden. + +Nähere Infos: [Git - gitignore](https://git-scm.com/docs/gitignore) + -- GitLab