Readme-Datei

Eine Readme-Datei (manchmal als README geschrieben) ist eine Textdatei, die grundlegende Dokumentation für ein Software-Programm bereitstellt. Sie wird normalerweise zusammen mit dem Installationsprogramm eines Programms bereitgestellt oder von diesem installiert. Die meisten Readme-Dateien sind Nur-Text-Dateien, einige können jedoch Bilder oder Videos enthalten.

Readme-Dateien enthalten typischerweise einige Kategorien von Informationen. Die meisten enthalten Anweisungen zum Konfigurieren und Verwenden des Programms, insbesondere wenn dafür Schritte erforderlich sind, die nicht intuitiv sein könnten. Außerdem werden darin Copyright-Informationen und die Namen der Entwickler angezeigt, sodass Benutzer erfahren, wer an der Entwicklung des Programms beteiligt war. Umfassende Readme-Dateien enthalten außerdem Schritte zur Fehlerbehebung bei häufigen Problemen sowie ein Änderungsprotokoll mit aktuellen Updates, Fehlerbehebungen und Patches.

Da inzwischen fast die gesamte Softwareverteilung über das Internet erfolgt, sind die Informationen aus einer Readme-Datei häufig auch auf der Website des Programms zu finden. Dadurch kann der Entwickler des Programms die Informationen regelmäßig aktualisieren und ein Änderungsprotokoll bereitstellen, das der Benutzer vor der Aktualisierung sehen kann. Der Entwickler kann mithilfe von Wiki-Software sogar eine umfassendere Dokumentation erstellen, indem er die Benutzerbasis des Programms einbezieht.