Was ist eine README-Datei?
Eine Readme-Datei ist eine Textdatei, die häufig in Software enthalten ist und allgemeine Informationen oder Anweisungen zur Software enthält. Die Besonderheiten dieser Informationen sind von Datei zu Datei sehr unterschiedlich. Eine Readme-Datei kann Installationsanweisungen, allgemeine Informationen zur Softwarenutzung, Nutzungsbedingungen und andere rechtliche Informationen oder sonstige für die Software relevante Informationen enthalten. Fast alle Readme-Dateien enthalten mindestens den Namen und die Version der Software, den Namen des Unternehmens oder der Person, die die Software entwickelt hat, und das Veröffentlichungsdatum. Es gibt jedoch keine allgemeine Formel zum Schreiben einer Readme, und der Inhalt hängt letztendlich von den Launen des Entwicklers ab.
Der Name "Readme" soll den Benutzer auf die Datei aufmerksam machen, da er häufig Informationen enthält, die für den ordnungsgemäßen Betrieb der Software erforderlich sind. In vielen Fällen wird der Dateiname einer Readme-Datei in Großbuchstaben geschrieben und heißt "README.txt" oder ähnliches. Einige Programmverzeichnisse verschieben großgeschriebene Dateinamen an den Anfang jeder Dateiliste. Durch die Großschreibung erhält die Readme-Datei einen höheren Stellenwert und der Software-Benutzer wird erneut aufgefordert, die Datei vor der Verwendung des Programms zu lesen. Einige Readme-Dateien tragen den Titel "Bitte zuerst lesen" oder ähnliches, um den Leser zu ermutigen, die Dokumentation zu lesen, bevor die Software ausgeführt wird.
Eine Readme-Datei kann viele verschiedene Arten von Informationen von unterschiedlicher Wichtigkeit enthalten. Zusätzlich zu den Namen und Dateiversionen, die im Allgemeinen enthalten sind, enthalten Readme-Dateien häufig auch einen Versionsverlauf oder ein Änderungsprotokoll, in dem Änderungen aufgeführt sind, die im Laufe der Zeit an der Software vorgenommen wurden. Eine Readme-Datei kann auch eine Liste bekannter Probleme oder Fehler enthalten, die sich auf die Verwendung der Software auswirken. Einige enthalten weniger wichtige Informationen wie Bestätigungen oder persönliche Nachrichten des Entwicklungsteams. Bei besonders einfachen Programmen kann die Readme-Datei tatsächlich als Benutzerhandbuch dienen, das Sie in die allgemeine Verwendung der Software einweist.
Aufwendige Readme-Dateien sind sehr selten, da Entwickler es in der Regel vorziehen, die erforderlichen Informationen auf einfache, übersichtliche und prägnante Weise darzustellen. Eine Readme-Datei wird normalerweise in einem Nur-Text-Format mit einer Standardschriftart und ohne Bilder angezeigt, es sei denn, der Entwickler ist der Ansicht, dass etwas Ausführlicheres erforderlich ist. Diese Einfachheit vermeidet unnötige Ablenkungen und hält den Leser auf die Informationen fokussiert. Manchmal wird eine Readme-Datei im Format "Häufig gestellte Fragen" oder "FAQ" angezeigt. In einem solchen Format prognostiziert der Entwickler die häufigsten Fragen zu der Software und gibt klare und einfache Antworten, anstatt alle technischen Informationen in einem Textblock zu platzieren, den die Benutzer möglicherweise nicht lesen möchten.