Readme

Als Readme oder Liesmich (englisch read me = lies mich) wird eine Datei bezeichnet, die üblicherweise mit Software mitgeliefert wird und diverse, oft wichtige Informationen über die Software enthält. Meist sind dies Details, die nicht mehr rechtzeitig bekannt wurden, um in das Handbuch aufgenommen zu werden, oder Korrekturen zu falschen Informationen im mitgelieferten Handbuch. Oft wird aber auch der Benutzer vor der Installation und vor der ersten Verwendung der Software über wichtige Details informiert, die für einen reibungslosen Einsatz der Software wichtig sind und die er daher unbedingt lesen sollte.

Ist der Dateiname in Großbuchstaben geschrieben, README, so ist dies entweder auf alten Dateisystemen systembedingt so entstanden (das FAT-Dateisystem speicherte ursprünglich nur Großbuchstaben mit 8.3-Begrenzung), oder dies ist beabsichtigt, damit die Datei besonders ins Auge fällt – durch die Großschreibung wird die Datei dann auf Systemen, die zwischen Groß- und Kleinschreibung (wie z. B. Unix und andere Derivate) unterscheiden, vor allen anderen Dateien gelistet, deren Namen mit Kleinbuchstaben beginnen. Übliche Dateinamen sind neben readme (alternativ auch mit großem Anfangsbuchstaben) und ReadMe auch die Übersetzung in andere Sprachen, etwa LiesMich oder LisezMoi, oft auch mit der Dateinamenserweiterung .txt oder .doc als Textdatei in Plain text.

Ob es bei reinen Textdateien überhaupt eine Dateinamenserweiterung gibt bzw. wie diese lautet, ist von Projekt zu Projekt unterschiedlich. Beispiele sind read.me ebenso wie readme.1st (engl. 1st, gesprochen first; in seiner Gesamtheit übersetzt etwa mit Lies mich zu(aller)erst) aber auch z. B. .rst in reStructuredText, .adoc in AsciiDoc oder.md in Markdown-Auszeichnung. Wenn neben Englisch weitere Sprachen unterstützt werden, wird das Länderkürzel mit in den Dateinamen aufgenommen. Eine deutsche README-Datei im Markdown-Format wäre zum Beispiel README-de.md