Anlegen einer README.md

Die README.md-Datei ist ein unerlässlicher Bestandteil eines Projekts.

Sie befindet sich im obersten Verzeichnis des Projekts und wird von GitLab beim Aufrufen der Projektseite dargestellt. Daher stellt die README.md den ersten Einstieg von Entwickler:innen und Nutzer:innen mit Ihrer Software dar.

Info

Die (englischsprachige) Dokumentation zum Schreiben von Markdown-Dateien finden Sie hier.

Um den Prozess der Erstellung dieser Datei für Ihre Software zu vereinfachen empfehlen wir sich bei der Erstellung an folgender README.md-Datei zu orientieren.

Beispiel einer README.md

README.md

# Name der Software

Hier steht eine **knappe** Beschreibung der Software.

- [EN](Link/zur/README_EN.md)
- [FR](Link/zur/README_FR.md)

Nach der Kurzbeschreibung folgt eine ausführlichere Beschreibung. Diese soll die Kurzbeschreibung weiter ergänzen.
- Zur besseren Übersicht sollten in dieser Bulletpoints verwendet werden.
- Empfohlene Struktur der Beschreibung:
    1. Problemstellung
        - "Die Software löst [Problem] durch [Technologie/Ansatz] ... "
    2. Funktionsweise
       "Die Software verwendet [Methode] um [Ergebnis] zu erreichen ..."
       "Sie baut auf [Vorlage/Tools] auf und erweitert [Funktion] um ..."
    3. Hauptfunktionen
        - Auflistung von 3-5 Schlüsselmerkmalen der Software
        - *Feature 1*
        - *Feature 2*
        - ...
    4. Weitere Hinweise

![Aussagekräftiges Bildschirmfoto der Software](Link/zu/einem/Screenshot.png)

## Quickstart

An dieser Stelle folgen Befehle zur schnellen Nutzung der Anwendung.
Wie zum Beispiel dieser Dockerbefehl:

    docker build -t projektname .
    docker run -p 8000:8000 projektname

## Installation

Hier steht eine ausführliche Installationsanleitung

### Anforderungen

- Auflistung der notwendigen Anforderungen
- *Anforderung 1*
- *Anforderung 2*
- ...

- Auflistung der genutzten Programmiersprachen:
- *Programmiersprache 1*
- *Programmiersprache 2*
- ...

- Optional
    - Auflistung von optionalen Anforderungen
    - *Anforderung 1*
    - *Anforderung 2*
    - ...

### Empfohlene Einstellungen (optional)

Hier kann eine Beschreibun empfohlener Einstellungen folgen.

### Häufige Fehler (optional)

- Nennen einiger häufiger Fehlerquellen.
- Fehlerquelle 1
- Fehlerquelle 2

Gerne auch mit Code-Beispielen zur Lösung:

    print("Hello World")

## FAQ

Am Besten an dieser Stelle einen Link zu häufig gestellten Fragen ("FAQ") angeben:

[FAQ](Link/zur/FAQ.md)

## Mitmachen

Hier steht eine **kurze** Beschreibung, welche Form der Beteiligung gewünscht ist.

Nach dieser Beschreibung sollte auf die Datei [`CONTRIBUTING.md`](Link/zur/CONTRIBUTING.md) verwiesen werden, sofern diese vorhanden ist.
- In dieser befindet sich eine ausführliche Darstellung der Möglichkeiten zur Beteiligung an dem Entwicklungsprozess.

- Auflistung der genutzen Entwicklungs-Kanäle
- [Changelog](https://link-zum-changelog.org)
- [Discourse](https://link-zum-discourse.org)
- [Bugtracker](https://link-zum-bugtracker.org)
- ...

## Lizenz

Dieses Projekt steht unter der [CC0-Lizenz](LICENSE).

Hinzufügen einer README.md zu einer Gruppe

Eine Anleitung zum Erstellen einer README.md-Datei für eine Gruppe finden sie hier.