Was ist das README-Dateiformat?
Eine .readme-Datei ist eine reine Textdokumentationsdatei, die der README-Konvention von Unix und der Open-Source-Softwarekultur folgt. Die Endung .readme ist eine seltene Variante der traditionellen Großschreibung README (ohne Endung) und der README.txt-Formen.
README-Dateien bieten eine für Menschen lesbare einführende Dokumentation für ein Softwarepaket, ein Projekt oder ein Archiv. Typische Inhalte sind eine Projektbeschreibung, Installations- und Gebrauchsanweisungen, Autoreninformationen und ein Lizenzhinweis. Es gibt keine verbindliche Struktur - der Inhalt besteht aus freiem Text und Listen.
Die großgeschriebene README ohne Endung stammt mindestens aus den 1970er Jahren in Unix-Distributionen, wo sie konventionell die erste Datei war, die ein Benutzer lesen sollte; Paketmanager und Verzeichnisauflistungen zeigten sie oft automatisch an. README.txt wurde unter Windows gebräuchlich. Seit etwa 2008 hat sich README.md (Markdown) als dominantes Format durchgesetzt, da GitHub Markdown auf Repository-Seiten automatisch rendert.
Die Endung .readme ist gelegentlich in älteren Shareware-Distributionen und bestimmten Paketmanagern zu finden, weist aber keinen technischen Unterschied zu .txt auf - beide sind reiner Text, den jeder Editor ohne Konfiguration öffnet. Die Kodierung ist normalerweise UTF-8 (modern) oder ASCII (veraltet); Windows-Tools können UTF-16 LE-Dateien mit einem BOM erzeugen, aber UTF-8 ist der Standard. Die Dateigröße liegt fast immer unter 100 KB.
Sicherheit
RISIKO: LOWReine Textdatei; kein ausführbarer Code; völlig sicher in jedem Texteditor zu öffnen.
Formatdetails
kurz gefasstProgramme zum Öffnen von README-Dateien
Windows3 apps
Windows Notepad
Integriert Doppelklick funktioniert eventuell nicht (Betriebssystem erkennt .readme-Endung nicht); Rechtsklick → Öffnen mit → Notepad. 
Visual Studio Code
Open Source Datei → Datei öffnen, wählen Sie die .readme-Datei aus; wird als reiner Text angezeigt. 
macOS2 apps
Visual Studio Code
Open Source Datei → Datei öffnen, wählen Sie die .readme-Datei aus; wird als reiner Text angezeigt. 
Linux2 apps
Technische Details
technische Spezifikation| Kodierung | UTF-8 (moderner Standard); ASCII (veraltet); gelegentlich UTF-16 LE mit BOM unter Windows |
| Container | Reiner Text - kein binärer Wrapper, kein Header, kein Schema |
| Verbindliche Struktur | Keine - freier Text; keine definierten Felder oder erforderliche Reihenfolge |
| Gängige Dateinamensvarianten | README (keine Endung), README.txt, README.md, .readme |
| MIME-Typ | text/plain |
| Typische Dateigröße | Fast immer unter 100 KB |
| Zeilenenden | LF (Unix/macOS/Linux) oder CRLF (Windows); beide werden von Texteditoren akzeptiert |
| UTF-8 BOM | Optional - möglich bei unter Windows erstellten Dateien (Präfix EF BB BF) |
| Dominante moderne Form | README.md (Markdown), automatisch gerendert von GitHub, GitLab und Bitbucket seit ca. 2008 |
| Historische Anzeige | Wurde von frühen Unix-Verzeichnisauflistungen und Paketmanagern automatisch angezeigt |
| Zugehörige Plattformen | Alle Betriebssysteme - Windows, macOS, Linux, Unix |
| Typischer Inhalt | Projektbeschreibung, Installations-/Gebrauchsanweisungen, Autoreninfo, Lizenzhinweis |
| Veröffentlicht | 1970s Unix tradition; .readme as a distinct extension less common than plain README or README.txt |
| Neueste Version | N/A - no versioning |
| Offener Standard | Ja · lizenzgebührenfrei |
README-Konvertierungen
Community Q&A
von Nutzern gefragtNoch keine Fragen - stellen Sie die erste Frage zu README-Dateien.
