Origine di "Readme"

32

Quando le persone hanno iniziato a scrivere file Leggimi?

Sembra che praticamente tutti i programmi abbiano questo file, indipendentemente dal formato.

Esiste un primo utilizzo documentato di questo documento?

documentation terminology history

— Mahmoud Hossam
fonte

19

Esiste un primo utilizzo documentato della documentazione del software? ...

— viti

1

Documentazione software @vines! = Readme

— Mahmoud Hossam,

Ma Readme appartiene.

— viti

2

@vines Sono sicuro che la documentazione del software precede la convenzione di utilizzare un file readme.

— Mahmoud Hossam,

21

Non conosco un primo utilizzo canonico. Il file Jargon descrive il file README come:

Introduzione hacker tradizionalmente inclusa nella directory di livello superiore di una distribuzione di sorgenti Unix

Quindi ho dato un'occhiata ad alcuni dei primi alberi di sorgenti unix, per gentile concessione di The Unix Tree (fornito da Unix Heritage Society e Unix Archive ). Alcuni file README trovati nei primi unice includono:

/ sys / source / lex / README da PWB 1.0 (luglio 1977) - il primo che ho potuto trovare
/ usr / doc / README dalla settima edizione (gennaio 1979) - il primo che ho potuto trovare per l'intero albero dei sorgenti
/ usr / doc / README di 3BSD (marzo 1980) - il primo che ho potuto trovare per un BSD

Quindi, i progressi del luglio 1977 sono i benvenuti!

— Tom Anderson
fonte

1

Va al di là di ITS, sfortunatamente è piuttosto difficile trovare qualcosa in realtà con data e ora alla data dell'ultima modifica, rispetto alla data in cui è stato archiviato. Il primo README fu probabilmente creato alla fine degli anni '60, ma dimostrarlo è piuttosto un compito.

— Tim Post

@Tim - un README su una pila di schede perforate!

— Martin Beckett,

Ne ho trovato uno da novembre 1974 e marzo 1975: programmers.stackexchange.com/questions/96966/origin-of-readme/…

— Hugo

10

Ho seguito un corso di Sistemi operativi lo scorso anno e ricordo che il mio professore mi disse che avevano i README (veri e propri file stampati fisici) per tutte le loro schede perforate e nastro magnetico e praticamente qualsiasi altra cosa che fosse un "programma". A quel tempo ne avevi davvero bisogno a causa del laborioso processo che comportava la creazione, l'esecuzione e tutto il resto. Questi README a volte includevano anche le stampe reali di come le schede perforate dovevano essere punzonate come una forma di controllo degli errori e di debug.

Apparentemente la convenzione segue anche il vecchio sistema in quanto con tutte le schede perforate veniva allegato un "reem" di carta con la dichiarazione README in maiuscolo stampato, che conteneva tutte le istruzioni per l'uso e il caricamento delle schede perforate nel sistema .

Per un riferimento temporale, questo sarebbe stato negli anni '60. Ma il sistema di schede perforate esiste dal 1700 per il controllo di telai "automatizzati", quindi forse anche vecchio come quello.

— Jeff Langemeier
fonte

8

Trovato tramite questo thread alt.folklore.computers :

Scommetto che alcuni dei documenti che accompagnano uno dei sistemi operativi PDP-8 o i pacchetti software saranno probabilmente i più vecchi.

Il più antico che ho trovato negli archivi PDP-10 è l'UCI LISP " READ.ME " dal nastro della biblioteca del 4 ° DECUS, con un timestamp del 27-mar-1975 :

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

Sfortunatamente, molti dei mini OS precedenti non supportano un timestamp [unico] nella struttura della directory del nastro e / o del disco, quindi è difficile dire quando un documento è stato veramente modificato l'ultima volta.

Non solo il file ha un timestamp del 27 marzo 1975, ma è facilmente firmato e datato nel file stesso :

                    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

Edit: Curiosando tra le PDP-10 Archives ho trovato un precedente README.TXT dal 27 novembre 1974 sia timestamp e firmato nel file di :

[README.TXT è il file DOC per SPICE / SINC / SLIC]

Questo nastro fail-safe contiene i programmi di analisi del circuito:
    SPICE SINC and SLIC
descritto nel volume 4 del bollettino software applicativo.

requisiti:

SPICE richiede FORTRAN-10 versione 4 a causa del suo uso dei dati Holerith regolati a destra. Esegue in circa 47K.

[...]

include anche questo file, i FOROT da associare ai SAV e l'origine di SECOND.MAC, la routine di temporizzazione. SPICE è suddiviso in tre parti: 1SPICE.FOR, 2 e 3.

Esiste un documento stampato per descrivere ciascuno dei programmi. Questi sono inclusi nel pacchetto DECUS. La documentazione e i programmi sono stati originariamente sviluppati dal dipartimento EE dell'Univ. of Calif. a Berkley su un CDC 6400. Tranne la conversione del FORTRAN nel DECsystem-10 non sono state apportate modifiche ai programmi. Per i dati di test SLIC e SINC hanno mostrato una leggera variazione rispetto al 6400, SPICE non mostra alcuna variazione.

In bocca al lupo! Ashley Grayson 27-NOV-74

[fine di README.TXT]

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

— Hugo
fonte