Readme

Als Readme oder Liesmich (engl. 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
[1][2]
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. Ob es überhaupt eine Dateinamenserweiterung gibt bzw. wie diese lautet, ist von Projekt zu Projekt unterschiedlich.
Verbreitete Beispiele sindread.me[3] ebenso wie readme.1st.[4]

Dateiformat
Die Readme-Datei ist üblicherweise in einem Format, das auf der Plattform, auf der die Software läuft, mit den vorhandenen
Textprogrammen gelesen werden kann.

Früher war eine Readme-Datei meist eine reine Textdatei, das heißt, sie enthielt nur ASCII-Zeichen, wodurch sie auf so gut wie allen
Computersystemen gelesen und ausgedruckt werden konnte, sogar auf Systemen, auf denen die Software, welche die Datei
beschrieben hatte, nicht genutzt werden konnte. Auch der zusammengeschriebene Dateiname (readme statt read me) war der
Kompatibilität geschuldet, da auf manchen Systemen ein Leerzeichen im Dateinamen zu Problemen führen konnte.

So waren Readme-Dateien unter IBM-PC-kompatiblem DOSfast immer einfache Textdateien, obwohl die Erweiterung neben .txt
auch oft .doc lautete, um auf den Betriebssystemen PC DOS und MS-DOS ohne zusätzliche Programme gelesen werden zu
konnten. Für Windows-Programme wurde hingegen oft das Dateiformat einer Textverarbeitung verwendet, etwa .wri, das mit Write
gelesen, oder .doc (dem Dateiformat von Microsoft Word), das auch mit WordPad gelesen werden konnte. Unter OS X ist das Rich
Text Format mit der Dateinamenserweiterung.rtf weit verbreitet.

Heute übliche Readme-Dateiformate sind meist in eine vereinfachte Auszeichnungssprache untergliedert oder im HTML-Format
ausgeliefert,[5] da davon ausgegangen werden kann, dass die meisten Systeme über einen Webbrowser verfügen. Teilweise wird auch
das Dateiformat PDF verwendet, das allerdings unter manchen Betriebssystemen ein spezielles Anzeigeprogramm erfordert. Dieses
wurde mit der Software oft mitgeliefert, weil es ohnehin auch für die beigelegte und aufwendiger gestaltete Benutzerdokumentation
benötigt wurde.

Trotz aller modernen Möglichkeiten hat sich die einfache Textdatei, allerdings nun oft in Unicode statt ASCII, für kleinere Readme-
Dateien bis heute erhalten.

Siehe auch
Textdatei
FILE_ID.DIZ
NFO
 Änderungsprotokoll (Changelog)

Quellen
1. http://www.wissenswertes.at/index.php?id=readme-datei
2. Definition bzw. Erklärung: Lies-mich-Datei(http://www.bullhost.de/l/lies-mich-datei.html) im Bullhost-PC-Lexikon;
abgerufen am 23. März 2016.
3. Telewerkstatt Leutschach, Liste von Dateiendungen (http://www.telewerkstatt.at/datei_endungen.htm#m) – die
Dateiendung .me findet sich bei einer read.me-Datei
4. Telewerkstatt Leutschach, Liste von Dateiendungen (http://www.telewerkstatt.at/datei_endungen.htm) – die
Dateiendung .1st ist für die Readme-Datei gedacht,readme.1st
5. Beispiel: http://www.python.org/ftp/python/README.html

Abgerufen von „https://de.wikipedia.org/w/index.php?title=Readme&oldid=160187276

“

Diese Seite wurde zuletzt am 29. November 2016 um 14:11 Uhr bearbeitet.

Der Text ist unter der Lizenz„Creative Commons Attribution/Share Alike“verfügbar; Informationen zu den Urhebern und
zum Lizenzstatus eingebundener Mediendateien (etwa Bilder oder ideos)
V können im Regelfall durch Anklicken dieser
abgerufen werden. Möglicherweise unterliegen die Inhalte jeweils zusätzlichen Bedingungen. Durch die Nutzung dieser
Website erklären Sie sich mit denNutzungsbedingungenund der Datenschutzrichtlinie einverstanden.
Wikipedia® ist eine eingetragene Marke der Wikimedia Foundation Inc.