imported>Bullenwächter: Vorlage Webarchiv auf Internetquelle umgestellt

2026-02-19T10:48:46Z

Vorlage Webarchiv auf Internetquelle umgestellt

Neue Seite

{{Begriffsklärungshinweis}}

Als '''Readme''' oder '''Liesmich''' ({{enS|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 (Computer)|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.<ref>{{Internetquelle |url=http://www.wissenswertes.at/index.php?id=readme-datei |titel=Computerlexikon: Readme-Datei |werk=Wissenswertes.at |offline=1 |archiv-url=https://web.archive.org/web/20120525120251/http://www.wissenswertes.at/index.php?id=readme-datei |archiv-datum=2012-05-25 |abruf=2025-02-19}}</ref>

Ist der [[Dateiname]] in Großbuchstaben geschrieben, <code>README</code>, so ist dies entweder auf alten Dateisystemen systembedingt so entstanden (das FAT-Dateisystem speicherte ursprünglich nur Großbuchstaben mit [[8.3|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 [[Unixoides System|Derivate]]) unterscheiden, vor allen anderen Dateien gelistet, deren Namen mit Kleinbuchstaben beginnen. Übliche Dateinamen sind neben <code>readme</code> (alternativ auch mit großem Anfangsbuchstaben) und <code>ReadMe</code> auch die Übersetzung in andere Sprachen, etwa <code>LiesMich</code> oder <code>LisezMoi</code>, oft auch mit der [[Dateinamenserweiterung]] <code>.txt</code> oder <code>.doc</code> 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 <code>read.me</code><ref>[http://www.telewerkstatt.at/datei_endungen.htm#m Telewerkstatt Leutschach, Liste von Dateiendungen] – die Dateiendung <code>.me</code> findet sich bei einer <code>read.me</code>-Datei</ref> ebenso wie <code>readme.1st</code><ref>{{Internetquelle |url=https://www.dateiendung.com/format/1st |titel=1st Dateiendung - Wie öffnet man 1st Dateien? |abruf=2024-02-02}}</ref> (engl. ''{{lang|en|1st}}'', gesprochen ''{{lang|en|first}}''; in seiner Gesamtheit übersetzt etwa mit ''Lies mich zu(aller)erst'') aber auch z. B. <code>.rst</code> in [[reStructuredText]], <code>.adoc</code> in [[AsciiDoc]] oder<code>.md</code> 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 <code>README-de.md</code><ref>{{Internetquelle |url=https://kubernetes.io/de/docs/contribute/localization/ |titel=Lokalisierung der Kubernetes Dokumentation |sprache=de |abruf=2024-02-02}}</ref>

== 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-kompatibles DOS|IBM-PC-kompatiblem DOS]] fast immer einfache Textdateien, obwohl die Erweiterung neben <code>.txt</code> auch oft <code>.doc</code> lautete, um auf den Betriebssystemen [[PC DOS]] und [[MS-DOS]] ohne zusätzliche Programme gelesen werden zu können. Für [[Microsoft Windows|Windows]]-Programme wurde hingegen oft das Dateiformat einer Textverarbeitung verwendet, etwa <code>.wri</code>, das mit [[Microsoft Write|Write]] gelesen, oder <code>.doc</code> (dem Dateiformat von [[Microsoft Word]]), das auch mit [[WordPad]] gelesen werden konnte. Unter [[macOS]] ist das [[Rich Text Format]] mit der Dateinamenserweiterung <code>.rtf</code> weit verbreitet.

Heute übliche Readme-Dateiformate sind meist in eine [[vereinfachte Auszeichnungssprache]] untergliedert oder im [[HTML]]-Format ausgeliefert,<ref>Beispiel: http://www.python.org/ftp/python/README.html</ref> 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 und oft erweitert durch die [[vereinfachte Auszeichnungssprache]] [[Markdown]], für kleinere Readme-Dateien bis heute erhalten.

== Siehe auch ==
* <span style="font-family: monospace, monospace;">[[FILE_ID.DIZ]]</span>
* <span style="font-family: monospace, monospace;">[[.nfo]]</span>
* [[Änderungsprotokoll]] ({{lang|en|Changelog}})

== Weblinks ==
* [https://docs.github.com/de/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes Informationen zu README-Dateien], [[GitHub]]

== Quellen ==
<references/>

[[Kategorie:Softwarekomponente]]

Readme - Versionsgeschichte

imported>Bullenwächter: Vorlage Webarchiv auf Internetquelle umgestellt