Origine du «Readme»

32

Quand les gens ont-ils commencé à écrire des fichiers Lisez-moi?

Il semble que presque tous les programmes ont ce fichier, quel que soit le format.

Y a-t-il une première utilisation documentée de ce document?

documentation terminology history

— Mahmoud Hossam
source

19

Y a-t-il une première utilisation documentée de la documentation du logiciel? ...

— vines

1

Documentation du logiciel @vines! = Lisez

— Mahmoud Hossam

Mais Readme appartient.

— vignes

2

@vines Je suis sûr que la documentation du logiciel précède la convention d'utilisation d'un fichier Lisezmoi.

— Mahmoud Hossam

21

Je ne connais pas de première utilisation canonique. Le fichier Jargon décrit le fichier README comme:

Introduction Hacker's-eye traditionnellement incluse dans le répertoire de niveau supérieur d'une distribution source Unix

J'ai donc jeté un coup d'œil à travers les premiers arbres sources Unix, gracieuseté de The Unix Tree (fourni par la Unix Heritage Society et les archives Unix ). Certains fichiers README trouvés dans les premières unités comprennent:

/ sys / source / lex / README de PWB 1.0 (juillet 1977) - le plus tôt que j'ai pu trouver
/ usr / doc / README de la septième édition (janvier 1979) - le plus ancien que j'ai pu trouver pour tout l'arbre source
/ usr / doc / README de 3BSD (mars 1980) - le premier que j'ai pu trouver pour un BSD

Les avancées de juillet 1977 sont donc les bienvenues!

— Tom Anderson
source

1

Cela remonte au-delà des STI, malheureusement, il est assez difficile de trouver quelque chose de réellement horodaté à la date de sa dernière modification, par rapport à la date de son archivage. Le premier fichier README a probablement été créé à la fin des années 1960, mais cela prouve que c'est une tâche difficile.

— Tim Post

@Tim - un README sur une pile de cartes perforées!

— Martin Beckett

J'en ai trouvé un de novembre 1974 et mars 1975: programmers.stackexchange.com/questions/96966/origin-of-readme/…

— Hugo

10

J'ai pris un cours sur les systèmes d'exploitation l'année dernière et je me souviens que mon professeur m'avait dit qu'ils avaient des fichiers README (des fichiers imprimés physiques) pour toutes leurs cartes perforées et leur bande magnétique et à peu près tout ce qui était un "programme". À ce moment-là, vous en aviez vraiment besoin en raison du processus laborieux qui consistait à créer, exécuter et tout le reste. Ces fichiers README comprenaient parfois également les impressions réelles de la façon dont les cartes perforées étaient censées être perforées comme une forme de vérification des erreurs et de débogage.

La convention suit apparemment aussi l'ancien système en ce que, avec toutes les cartes perforées, un "reem" de papier était attaché avec la déclaration README en majuscules imprimée dessus, qui contenait toutes les instructions d'utilisation et de chargement des cartes perforées dans le système. .

Pour une référence temporelle, cela aurait été dans les années 60. Mais le système de cartes perforées existe depuis les années 1700 pour contrôler les métiers "automatisés", donc peut-être même aussi vieux que cela.

— Jeff Langemeier
source

8

Trouvé via ce fil alt.folklore.computers :

Je parie qu'un document accompagnant l'un des systèmes d'exploitation PDP-8 ou des progiciels sera probablement le plus ancien.

La plus ancienne que j'ai trouvée dans les archives PDP-10 est la liste UCI LISP " READ.ME " de la 4ème cassette de la bibliothèque DECUS, avec un horodatage du 27 mars 1975 :

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

Malheureusement, la plupart des mini-OS antérieurs ne prennent pas en charge un horodatage [unique] dans la structure du répertoire de la bande et / ou du disque, il est donc difficile de dire quand un document a été réellement modifié pour la dernière fois.

Non seulement le fichier a un horodatage du 27 mars 1975, mais il est facilement signé et daté dans le fichier lui - même :

                    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: en parcourant les archives PDP-10, j'ai trouvé un README.TXT antérieur du 27 novembre 1974, à la fois horodaté et signé dans le fichier :

[README.TXT est le fichier DOC pour SPICE / SINC / SLIC]

Cette bande de sécurité contient les programmes d'analyse de circuit:
    SPICE SINC and SLIC
décrit dans le Volume 4 du Bulletin des logiciels d’application.

exigences:

SPICE nécessite FORTRAN-10 version 4 en raison de son utilisation des données Holerith ajustées à droite. Exécute dans environ 47K.

[...]

il inclut également ce fichier, les FOROTS pour aller avec les SAV et la source pour SECOND.MAC, la routine de chronométrage. SPICE est divisé en trois parties: 1SPICE.FOR, 2 et 3.

Il existe un document imprimé pour décrire chacun des programmes. Ceux-ci sont inclus dans le paquet DECUS. La documentation et les programmes ont été développés à l'origine par le département EE de l'Univ. de Californie à Berkley sur un CDC 6400. Sauf pour convertir le FORTRAN en DECsystem-10, aucun changement n'a été apporté aux programmes. Pour les données de test SLIC et SINC ont montré une légère variation par rapport au 6400, SPICE ne montre aucune variation.

Bonne chance! Ashley Grayson 27-NOV-74

[fin de README.TXT]

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

— Hugo
source