Herkunft von "Readme"

32

Wann haben die Leute angefangen, Readme-Dateien zu schreiben?

Es scheint, dass so ziemlich alle Programme diese Datei haben, unabhängig vom Format.

Gibt es eine dokumentierte erste Verwendung dieses Dokuments?

documentation terminology history Mahmoud Hossam
quelle
19
Gibt es eine dokumentierte erste Verwendung der Software-Dokumentation? ...
Reben
1
@ vines software documentation! = Readme
Mahmoud Hossam
Aber Liesmich gehört dazu.
Reben
2
Ich bin sicher, dass die Software-Dokumentation der Konvention der Verwendung einer Readme-Datei vorausgeht.
Mahmoud Hossam

Antworten:

21

Ich kenne keinen kanonischen Erstgebrauch. Die Jargon-Datei beschreibt die README als:

Die Einführung von Hacker's Eye ist traditionell im Hauptverzeichnis einer Unix-Quelldistribution enthalten

Also habe ich einige frühe Unix-Quellbäume mit freundlicher Genehmigung von The Unix Tree (zur Verfügung gestellt von der Unix Heritage Society und dem Unix Archive ) durchgesehen . Einige README-Dateien, die in frühen Unices gefunden wurden, umfassen:

Fortschritte im Juli 1977 sind also willkommen!

Tom Anderson
quelle
1
Es geht zurück über ITS, leider ist es ziemlich schwierig, etwas zu finden, das zum Zeitpunkt der letzten Änderung tatsächlich mit einem Zeitstempel versehen ist, verglichen mit dem Datum, an dem es archiviert wurde. Die erste README-Datei wurde wahrscheinlich in den späten 1960er Jahren erstellt, aber das zu beweisen , ist eine ziemliche Aufgabe.
Tim Post
@Tim - eine README auf einem Stapel Lochkarten!
Martin Beckett
Ich fand eine von November 1974 und März 1975: programmers.stackexchange.com/questions/96966/origin-of-readme/…
Hugo
10

Ich habe letztes Jahr an einem Kurs über Betriebssysteme teilgenommen und erinnere mich, dass mein Professor mir erzählte, dass sie READMEs (physisch gedruckte Dateien) für alle ihre Lochkarten und Magnetbänder und so ziemlich alles andere hatten, was ein "Programm" war. Zu dieser Zeit brauchten Sie wirklich einen, weil der Prozess, der mit dem Erstellen, Ausführen und allem anderen verbunden war, mühsam war. Diese READMEs enthielten manchmal auch die tatsächlichen Ausdrucke, wie die Lochkarten als eine Form der Fehlerprüfung und des Debuggens gelocht werden sollten.

Die Konvention folgt anscheinend auch dem alten System, indem mit allen Lochkarten ein "Zettel" mit der Aufschrift README in aufgedruckten Kappen versehen wurde, auf dem alle Anweisungen zur Verwendung und zum Einlegen der Lochkarten in das System vermerkt waren .

Für eine Zeitangabe wäre dies in den 60er Jahren gewesen. Aber das Lochkartensystem gibt es schon seit dem 18. Jahrhundert für die Steuerung von "automatisierten" Webstühlen, vielleicht sogar so alt.

Jeff Langemeier
quelle
8

Über diesen alt.folklore.computers- Thread gefunden:

Ich wette, dass ein Dokument, das einem der PDP-8-Betriebssysteme beiliegt, oder Softwarepakete wahrscheinlich das älteste sein werden.

Das älteste, das ich in den PDP-10-Archiven gefunden habe, ist das UCI LISP " READ.ME " aus dem 4. DECUS-Bibliotheksband mit einem Zeitstempel vom 27. März 1975 :

http://pdp-10.trailing-edge.com/decuslib10-04/index.html

Leider unterstützen viele der früheren Mini-Betriebssysteme keinen [eindeutigen] Zeitstempel in der Band- und / oder Festplattenverzeichnisstruktur, so dass es schwierig ist festzustellen, wann ein Dokument wirklich zuletzt bearbeitet wurde.

Die Datei hat nicht nur einen Zeitstempel vom 27. März 1975, sondern ist auch handschriftlich signiert und in der Datei selbst datiert :

                    UCI LISP

                    Random Notes

                    [...]

  Should  problems  arise  with   this   system,  please
  communicate  them  to  the  Department  of  Information and
  Computer Science at UCI;  they will be directed to whomever
  is currently managing the UCI LISP system.

            William J. Earl
            Department of Information and Computer Science
            University of California
            Irvine, California

            27 March 1975

Bearbeiten: Durchsuchen des PDP-10-Archivs Ich habe eine frühere README.TXT vom 27. November 1974 gefunden, beide mit einem Zeitstempel versehen und in der Datei signiert :

[README.TXT ist die DOC-Datei für SPICE / SINC / SLIC]

Dieses ausfallsichere Band enthält die Schaltungsanalyseprogramme:

    SPICE SINC and SLIC

beschrieben im Applications Software Bulletin Volume 4.

Anforderungen:

Für SPICE ist FORTRAN-10 Version 4 erforderlich, da die Daten von Holerith mit den richtigen Einstellungen verwendet werden. Führt in ungefähr 47K durch.

[...]

Es enthält auch diese Datei, die FOROTS für die SAVs und die Quelle für SECOND.MAC, die Timing-Routine. SPICE besteht aus drei Teilen: 1SPICE.FOR, 2 und 3.

Zu jedem Programm gibt es ein gedrucktes Dokument. Diese sind im DECUS-Paket enthalten. Die Dokumentation und die Programme wurden ursprünglich von der EE-Abteilung der Univ entwickelt. von Calif. in Berkley auf einer CDC 6400. Außer der Konvertierung des FORTRAN in das DECsystem-10 wurden keine Änderungen an den Programmen vorgenommen. Für die Testdaten haben SLIC und SINC eine leichte Abweichung gegenüber dem 6400 gezeigt, SPICE zeigt keine Abweichung.

Viel Glück! Ashley Grayson 27-NOV-74

[Ende von README.TXT]

http://pdp-10.trailing-edge.com/decus_20tap3_198111/01/decus/20-0079/readme.txt.html

Hugo
quelle