Liesmich

Screenshot für die Readme -Datei von Locken

A Liesmich Datei Enthält Informationen zu den anderen Dateien in a Verzeichnis oder Archiv von Computer Software. Eine Form von Dokumentation, es ist normalerweise einfach einfacher Text Datei aufgerufen Liesmich, Liesmich, LIESMICH, Readme.txt,[1] Readme.md (Um die Verwendung von anzuzeigen Markdown), oder Readme.1st.[2]

Der Name der Datei ist in der Regel in Großbuchstaben geschrieben. An Unix-artig Insbesondere Systeme stammen dies hervor - sowohl weil Kleinkappenfilennamen häufiger sind und weil die ls Der Befehl sortiert und zeigt Dateien in üblicherweise in ASCII-Code-Reihenfolge, in denen Großbuchstaben zuerst erscheinen.[NB 1]

Inhalt

Eine Readme -Datei umfasst normalerweise:

Geschichte

Es ist unklar, wann die Konvention der Aufnahme einer Readme-Datei begann, aber es wurden Beispiele aus der Mitte der 1970er Jahre gefunden.[4][5][6][7][8][9][2] Frühzeitig Macintosh -Systemsoftware Installierte ein Read Me auf der Startdiskette und readMe-Dateien, die üblicherweise Software von Drittanbietern begleiteten.

Insbesondere gibt es eine lange Geschichte von gratis Software und Quelloffene Software einschließlich einer Readme -Datei; das GNU -Codierungsstandards Ermutigen Sie ein, einen zu geben, "einen allgemeinen Überblick über das Paket" zu geben.[10]

Seit dem Aufkommen der Netz Als ein de facto Standard Plattform für Softwareverteilung, viele Softwarepakete haben einige der oben genannten Zusatzdateien und Informationen zu einem verschoben (oder gelegentlich kopiert) Webseite oder Wikimanchmal auch die Readme selbst oder manchmal nur eine kurze Readme -Datei ohne alle Informationen hinterlassen, die von einem neuen Benutzer der Software erforderlich sind.

Der populäre Quellcode Hosting -Website GitHub Ermutigt die Erstellung einer Readme-Datei stark-wenn man im Hauptverzeichnis eines Repositorys (oberster Ebene) vorhanden ist, wird sie automatisch auf der Titelseite des Repositorys präsentiert. Zusätzlich zu einem einfachen Text, verschiedenen anderen Formaten und Dateierweiterungen werden auch unterstützt,[11] und HTML -Conversion berücksichtigt Erweiterungen - insbesondere a Readme.md wird als behandelt Markdown mit Github -Aroma.

Als generischer Begriff

Der Ausdruck "ReadMe -Datei" wird manchmal auch generisch für andere Dateien mit einem ähnlichen Zweck verwendet. Zum Beispiel die Quellcode-Verteilungen vieler kostenloser Softwarepakete (insbesondere solche, die dem folgen Gits Standards oder die produzierten mit GNU Autotools) Fügen Sie einen Standardsatz von Readme -Dateien hinzu:

Liesmich Allgemeine Information
Autoren Credits
DANKE Anerkennung
ÄNDERUNGSPROTOKOLL Ein detaillierter ChangeLog, der für Programmierer bestimmt ist
NACHRICHTEN Ein grundlegender ChangeLog, der für Benutzer bestimmt ist
INSTALLIEREN Installationsanleitung
KOPIEREN / LIZENZ Copyright- und Lizenzinformationen
Käfer Bekannte Fehler und Anweisungen zur Berichterstattung über neue
Beitragen / Hacking Leitfaden für potenzielle Mitwirkende des Projekts

Auch häufig mit Softwarepaketen verteilt sind ein FAQ Datei und a MACHEN Datei, in der geplante Verbesserungen aufgeführt sind.

Siehe auch

Anmerkungen

  1. ^ Dies ist oft nicht mehr der Fall - aber Lc_all = c ls wird das ältere Verhalten zeigen.

Verweise

  1. ^ Raymond, Eric Steven (1996). Das Wörterbuch des neuen Hackers. MIT Press. S. 378–79. ISBN 978-0-26268092-9. Hacker's-Eye-Einführung traditionell im obersten Verzeichnis einer Unix-Quellverteilung aufgenommen, die einen Zeiger auf detailliertere Dokumentation, Credits, verschiedene Überarbeitungsgeschichte, Notizen usw. enthält […] Bei der Aufforderung beziehen Hacker ausnahmslos die ReadMe-Konvention mit der Berühmte Szene in Lewis Carrolls Alice's Adventures im Wunderland, in der Alice Magic konfrontiert, als "Eat Me" und "Drink Me" bezeichnet.
  2. ^ a b Abdelhafith, Omar (2015-08-13). "Readme.md: Geschichte und Komponenten". Archiviert vom Original am 2020-01-25. Abgerufen 2020-01-25.
  3. ^ a b Mans, Stephen (November 1996). "Readme? Sicher-bevor ich es kaufe!". PC Welt. 14 (11): 366.
  4. ^ "PDP-10-Archiv: Decus/20-0079/Readme.txt von Decus_20tap3_198111". pdp-10.trailing-edge.com. 1974-11-27. Abgerufen 2018-03-03. [ReadMe.txt ist die DOC-Datei für Spice/Sinc/SLIC] Dieses fehlgeschlagene Band enthält die in der Anwendungssoftware Bulletin Volume 4. Anforderungen: Spice erfordert Fortran-10-Version 4 aufgrund seiner Verwendung von den Schaltungsanalyse-Programmen. Rechtsbereinigte Holerith -Daten. Führt in etwa 47.000 aus. […] Es enthält auch diese Datei, die Forten, die mit den Speichern und der Quelle für Second.mac, die Timing -Routine, entsprechen. Das Gewürz wird in drei Teile unterteilt: 1Spice.FOR, 2 und 3. Es gibt ein gedrucktes Dokument, um jedes der Programme zu beschreiben. Diese sind im DECUS -Paket enthalten. Die Dokumentation und Programme wurden ursprünglich von der E.E. Department der Univ. von Kalifornien in Berkeley auf einem CDC 6400. Außer den Fortran in das Decsystem-10 wurden keine Änderungen an den Programmen vorgenommen. Für die Testdaten haben SLIC und SINC eine geringfügige Abweichung in Bezug auf den 6400 gezeigt, was die Gewürz keine Variation zeigt. Viel Glück! Ashley Grayson 27-Nov-74 [Ende von Readme.txt]
  5. ^ "Decus 10-LIB-4 enthält 10-210 bis 10-241, außer 10-223". pdp-10.trailing-edge.com. 1975-03-27. Abgerufen 2018-03-03. Die Dateien auf diesem fehlgeschlagenen Band bilden das UCI -LISP -System. Sie sind größtenteils im UCI -LISP -Handbuch dokumentiert, das vom Ministerium für Information und Informatik der University of California, Irvine, Kalifornien, erhältlich ist. [1]
  6. ^ "Workbench/sys/source/lex/readme des Programmierers". Juli 1977. Abgerufen 2020-01-25.
  7. ^ "Unix 7th Edition/usr/doc/Readme". 1979. Abgerufen 2020-01-25.
  8. ^ "First 32bit BSD USR/Doc/Readme". März 1980. Abgerufen 2020-01-25.
  9. ^ Langemeier, Jeff (2011-07-29). "Re: Herkunft von Readme". Abgerufen 2020-01-25 - Via Stockexchange. […] Sie hatten Readmes (tatsächliche physische gedruckte Dateien) für all ihre Punschkarten und MAG Tape und so ziemlich alles andere, was ein "Programm" war.Zu dieser Zeit brauchten Sie einen wirklich wegen des arbeitslosen Prozesses, der sich mit dem Erstellen, Ran und allem anderen befasste.Diese Readmes enthielten manchmal auch die tatsächlichen Ausdrucke, wie die Punschkarten als Fehlerprüfung und -Debuggen geschlagen werden sollten.Die Konvention folgt offenbar auch dem alten System, da mit allen Punschkarten eine "Reem" von Papier mit der Anweisung Readme in Caps, die darauf gedruckt wurden.Für eine Zeitreferenz wäre dies in den 60ern gewesen.[…]
  10. ^ "GNU -Codierungsstandards: Veröffentlichungen". www.gnu.org. Abgerufen 2018-03-03.
  11. ^ "Markup". GitHub. Github. 2014-12-25. Abgerufen 2015-02-08.

Weitere Lektüre

Dieser Artikel basiert teilweise auf der Jargon -Datei, was öffentlich zugänglich ist.