Eine gute README schreiben (mit Beispiel und kostenlosem Generator)

Eine README ist das Erste, was Leute sehen, wenn sie dein Projekt öffnen. Sie muss schnell drei Fragen beantworten: Was ist das, wie fange ich an, und darf ich es nutzen? Tut sie das nicht, gehen die meisten wieder, egal wie gut der Code ist. Und in sechs Monaten liest sie vielleicht du selbst.

Diese Anleitung zeigt, was in eine gute README gehört und in welcher Reihenfolge, mit einem vollständigen Beispiel. Wenn du nicht mit einer leeren Seite anfangen möchtest, schreibt der kostenlose README-Generator sie aus einem kurzen Formular.

Was ist eine README-Datei?

Eine Textdatei im obersten Ordner eines Projekts, meist README.md genannt. Das .md bedeutet, dass sie in Markdown geschrieben ist, einer einfachen Art, Text zu formatieren. GitHub, GitLab und ähnliche Websites zeigen sie automatisch auf der Projektseite an. Sie ist also die Startseite deines Projekts.

Was in eine README gehört, der Reihe nach

1. Name und Beschreibung in einer Zeile. Sag, was es tut, nicht, wie es gebaut ist. „Speichere deine Lieblingsrezepte und finde sie in Sekunden wieder“ ist besser als „Eine Anwendung mit React und Node.js“.
2. Badges (optional). Kleine Etiketten mit der Lizenz, der aktuellen Version oder der Zahl der Sterne.
3. Inhaltsverzeichnis. Lohnt sich, sobald die README länger als eine Bildschirmseite ist.
4. Über das Projekt. Zwei oder drei Sätze: welches Problem es löst und für wen es gedacht ist.
5. Funktionen. Eine kurze Liste, damit man auf einen Blick sieht, ob es das Nötige kann.
6. Installation. Die genauen Befehle, fertig zum Kopieren. Probiere sie selbst auf einem frischen Rechner aus: Fehlende Schritte sind das häufigste README-Problem.
7. Verwendung. Das kleinste Beispiel, das funktioniert. Ein kurzes Codebeispiel sagt mehr als eine lange Erklärung.
8. Screenshot. Bei allem mit einer Oberfläche spart ein Bild einen Absatz.
9. Mitwirken. Wie andere helfen können, etwa indem sie ein Issue öffnen, bevor sie eine Änderung schicken.
10. Lizenz und Autor. Was man mit deiner Arbeit machen darf und wer sie gemacht hat.

Ein kleines Projekt braucht nicht alles. Der Kern sind Name, Beschreibung, Installation, Verwendung und Lizenz.

Ein vollständiges README-Beispiel

Hier ist eine kurze README für ein kleines Projekt, fertig zum Anpassen:

# recipe-box

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)

Save your favourite recipes and find them again in seconds.

## Table of contents

- [About](#about)
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [License](#license)

## About

A small app for people with too many recipes in too many places.
Everything is stored on your own computer.

## Features

- Search by ingredient
- Works offline
- Export to PDF

## Installation

```bash
git clone https://github.com/janedoe/recipe-box.git
cd recipe-box
npm install
```

## Usage

Start the app and open http://localhost:3000:

```bash
npm start
```

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

© 2026 Jane Doe

So erstellst du eine mit dem Generator

1. Öffne den README-Generator. Klicke auf Beispiel, um eine ausgefüllte Version zu sehen, oder auf Leeren, um mit deiner eigenen zu beginnen.
2. Fülle Projektname und Beschreibung in einer Zeile aus. Ergänze das GitHub-Repository als besitzer/name und das npm-Paket, falls vorhanden: Badges und Links nutzen sie.
3. Fülle die gewünschten Abschnitte aus, etwa Funktionen (eine pro Zeile), Installation und Verwendung. Leere Abschnitte werden weggelassen.
4. Setze oder entferne die Häkchen bei Badges und Inhaltsverzeichnis und wähle eine Lizenz.
5. Prüfe das Ergebnis unter Vorschau oder sieh dir den Code unter Markdown an und klicke dann auf Kopieren oder Herunterladen. Die heruntergeladene Datei trägt ein Datum im Namen, benenne sie also in README.md um.

Du kannst die README auf Englisch, Spanisch, Deutsch oder Französisch schreiben: Sprache der README legt die Überschriften und Standardsätze fest, und was du selbst tippst, bleibt, wie es ist. Badges erscheinen in der Vorschau als beschriftete Kästen, weil sie keine Bilder von anderen Websites lädt; auf GitHub werden sie normal angezeigt.

Welche Lizenz soll ich wählen?

Ohne Lizenz haben andere kein klares Recht, deinen Code zu nutzen, auch wenn er öffentlich ist. Das sind die Optionen im Generator, kurz gefasst. Das ist eine allgemeine Information, keine Rechtsberatung.

• MIT und ISC: kurz und freizügig. Fast alles ist erlaubt, solange dein Copyright-Hinweis erhalten bleibt.
• Apache-2.0: ebenfalls freizügig, mit einer ausdrücklichen Patentlizenz.
• BSD-3-Clause: freizügig, und niemand darf ohne Erlaubnis mit deinem Namen für seine Produkte werben.
• MPL-2.0: Änderungen an deinen Dateien müssen geteilt werden, aber diese Dateien dürfen Teil eines größeren geschlossenen Projekts sein.
• GPL-3.0: Alles, was auf deinem Code aufbaut und weitergegeben wird, muss ebenfalls unter der GPL offen sein.

Ein Schritt, den die README nicht für dich erledigt: Der Abschnitt Lizenz verweist nur auf die Lizenz. Lege den vollständigen Text auch als Datei namens LICENSE an. Wähle auf GitHub Add file, gib LICENSE als Namen ein und wähle eine Vorlage.

Häufige README-Fehler

• Mit der Technik anfangen. Sag zuerst, was es für die Leser tut.
• Befehle, die nicht funktionieren. Führe sie selbst aus und aktualisiere sie, wenn sich das Projekt ändert.
• Wissen voraussetzen. Nenne, was vorher installiert sein muss, etwa Node.js oder Python, und in welcher Version.
• Eine Textwand. Nutze Überschriften, kurze Listen und Codeblöcke.

Weitere Markdown-Tools

• Markdown-Tabellengenerator: Baue Tabellen für deine README in einem Raster oder füge sie aus Excel ein.
• Markdown zu HTML: Mach aus deiner README eine Webseite. Siehe auch Markdown in HTML umwandeln.

Häufige Fragen

Muss sie README.md heißen?

Ja, wenn GitHub und ähnliche Websites sie automatisch anzeigen sollen. Lege sie in den obersten Ordner des Projekts.

Wird hochgeladen, was ich eintippe?

Nein. Die README entsteht in deinem Browser, deshalb verlässt das, was du eintippst, nie dein Gerät. Das Ausfüllen ist kostenlos; Kopieren oder Herunterladen des Ergebnisses zählt als eine Nutzung deines Tageskontingents.

Kann ich die README später ändern?

Ja. Sie ist eine reine Textdatei: Bearbeite sie in einem beliebigen Texteditor oder direkt auf GitHub. Aktualisiere sie, wenn sich Installation oder Verwendung ändern.