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 einen reibungslosen Einsatz der Software wichtig sind und die er daher unbedingt lesen sollte.[1][2]

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 sind read.me[3] ebenso wie readme.1st[4] (engl. 1st, gesprochen first; in seiner Gesamtheit übersetzt etwa mit Lies mich zu(aller)erst).

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 DOS fast 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 können. 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 macOS 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

Quellen

  1. ↑ Archivierte Kopie (Memento des Originals vom 25. Mai 2012 im Internet Archive)  Info: Der Archivlink wurde automatisch eingesetzt und noch nicht geprüft. Bitte prüfe Original- und Archivlink gemäß Anleitung und entferne dann diesen Hinweis.@1@2Vorlage:Webachiv/IABot/www.wissenswertes.at
  2. ↑ Definition bzw. Erklärung: Lies-mich-Datei im Bullhost-PC-Lexikon; abgerufen am 23. März 2016.
  3. ↑ Telewerkstatt Leutschach, Liste von Dateiendungen – die Dateiendung .me findet sich bei einer read.me-Datei
  4. ↑ Telewerkstatt Leutschach, Liste von Dateiendungen – die Dateiendung .1st ist für die Readme-Datei gedacht, readme.1st
  5. ↑ Beispiel: http://www.python.org/ftp/python/README.html