Pochodzenie „Readme”

32

Kiedy ludzie zaczęli pisać pliki Readme?

Wygląda na to, że prawie wszystkie programy mają ten plik, niezależnie od formatu.

Czy jest udokumentowane pierwsze użycie tego dokumentu?

documentation terminology history Mahmoud Hossam
źródło
19
Czy jest udokumentowane pierwsze użycie dokumentacji oprogramowania? ...
vines
1
Dokumentacja oprogramowania @vines! = Readme
Mahmoud Hossam,
Ale plik Readme należy do.
winorośl
2
@ vines Jestem pewien, że dokumentacja oprogramowania poprzedza konwencję korzystania z pliku readme.
Mahmoud Hossam

Odpowiedzi:

21

Nie znam kanonicznego pierwszego użycia. Pliku Fachowe opisuje README jako:

Wprowadzenie do oka hakera tradycyjnie zawarte w katalogu najwyższego poziomu dystrybucji źródeł uniksowych

Więc przejrzałem niektóre wczesne drzewa źródeł uniksowych, dzięki uprzejmości The Unix Tree (dostarczone przez Unix Heritage Society i Unix Archive ). Niektóre pliki README znalezione we wczesnych jednorożcach to:

Tak więc postępy w lipcu 1977 r. Są mile widziane!

Tom Anderson
źródło
1
Wykracza poza ITS, niestety raczej trudno jest znaleźć coś, co faktycznie ma znacznik czasu w dniu jego ostatniej modyfikacji, w porównaniu do daty jego zarchiwizowania. Pierwszy plik README powstał prawdopodobnie pod koniec lat 60. XX wieku, ale udowodnienie, że jest to dość trudne zadanie.
Tim Post
@Tim - README na stosie kart dziurkacza!
Martin Beckett,
Znalazłem jeden z listopada 1974 r. I marca 1975 r .: programmers.stackexchange.com/questions/96966/origin-of-readme/…
Hugo
10

W zeszłym roku wziąłem udział w zajęciach z systemów operacyjnych i pamiętam, jak mój profesor powiedział mi, że mają pliki README (rzeczywiste fizyczne drukowane pliki) dla wszystkich swoich kart dziurkaczy i taśmy magnetycznej i praktycznie wszystkiego innego, co jest „programem”. W tym czasie naprawdę potrzebujesz jednego z powodu pracochłonnego procesu, który był związany z uzyskaniem stworzonego, uruchomionego i wszystkiego innego. Te pliki README czasami zawierały również rzeczywiste wydruki tego, w jaki sposób karty dziurkowania miały być dziurkowane jako forma sprawdzania błędów i debugowania.

Konwencja najwyraźniej jest również zgodna ze starym systemem, ponieważ ze wszystkimi kartami dziurkaczy dołączono „reem” papieru z nadrukowanym na nim oświadczeniem README, co zawierało wszystkie instrukcje dotyczące używania i ładowania kart dziurkowania do systemu .

Dla odniesienia czasu byłoby to w latach 60-tych. Ale system kart perforowanych istnieje już od 1700 roku w celu kontrolowania „automatycznych” krosien, więc może nawet tak starych.

Jeff Langemeier
źródło
8

Znalezione przez ten wątek alt.folklore.computers :

Założę się, że jakiś dokument towarzyszący jednemu z systemów operacyjnych PDP-8 lub pakietów oprogramowania będzie prawdopodobnie najstarszy.

Najstarsze, jakie znalazłem w archiwach PDP-10, to UCI LISP „ READ.ME ” z taśmy bibliotecznej 4. DECUS, z datownikiem 27 marca 1975 r . :

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

Niestety, wiele wcześniejszych mini-systemów operacyjnych nie obsługuje [unikalnego] znacznika czasu w strukturze katalogów taśm i / lub dysku, więc trudno jest powiedzieć, kiedy dokument był ostatnio edytowany.

Plik ma nie tylko sygnaturę czasową z 27 marca 1975 r., Ale jest też dobrze podpisany i opatrzony datą w samym pliku :

                    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

Edycja: przeglądanie archiwów PDP-10 Znalazłem wcześniejszy plik README.TXT z 27 listopada 1974 r., Zarówno znacznik czasu , jak i podpisany w pliku :

[README.TXT to plik DOC dla SPICE / SINC / SLIC]

Ta bezpieczna taśma zawiera programy do analizy obwodów:

    SPICE SINC and SLIC

opisane w Biuletynie Oprogramowania, tom 4.

wymagania:

SPICE wymaga FORTRAN-10 w wersji 4, ponieważ wykorzystuje dane Holerith dostosowane do potrzeb. Wykonuje się w około 47 tys.

[...]

zawiera również ten plik, FOROTY do zapisania w SAVes i źródło SECOND.MAC, procedurę pomiaru czasu. Przyprawa jest podzielona na trzy części: 1SPICE.FOR, 2 i 3.

Jest wydrukowany dokument opisujący każdy z programów. Są one zawarte w pakiecie DECUS. Dokumentacja i programy zostały pierwotnie opracowane przez dział EE Univ. Calif. w Berkley na CDC 6400. Poza konwertowaniem FORTRAN na DECsystem-10 nie wprowadzono żadnych zmian w programach. W przypadku danych testowych SLIC i SINC wykazały niewielką zmianę w stosunku do 6400, SPICE nie wykazuje żadnej zmiany.

Powodzenia! Ashley Grayson 27-NOV-74

[koniec README.TXT]

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

Hugo
źródło