Origen del "Léame"

32

¿Cuándo comenzaron las personas a escribir archivos Léame?

Parece que casi todos los programas tienen este archivo, independientemente del formato.

¿Hay algún primer uso documentado de este documento?

documentation terminology history

— Mahmoud Hossam
fuente

19

¿Hay algún primer uso documentado de la documentación del software? ...

— vides

1

@vines software documentation! = Léame

— Mahmoud Hossam

Pero Léame pertenece.

— vides

2

@vines Estoy seguro de que la documentación del software precede a la convención de usar un archivo readme.

— Mahmoud Hossam

21

No sé de un primer uso canónico. El archivo de jerga describe el archivo README como:

Introducción de Hacker's Eye tradicionalmente incluida en el directorio de nivel superior de una distribución fuente de Unix

Así que eché un vistazo a algunos de los primeros árboles fuente de Unix, cortesía de The Unix Tree (proporcionado por la Unix Heritage Society y el Unix Archive ). Algunos archivos README encontrados en los primeros unices incluyen:

/ sys / source / lex / README de PWB 1.0 (julio de 1977) - lo más temprano que pude encontrar
/ usr / doc / README de la Séptima Edición (enero de 1979) - lo más temprano que pude encontrar para todo el árbol fuente
/ usr / doc / README de 3BSD (marzo de 1980): lo más temprano que pude encontrar para un BSD

¡Entonces, los avances en julio de 1977 son bienvenidos!

— Tom Anderson
fuente

1

Se remonta más allá de ITS, desafortunadamente es bastante difícil encontrar algo en realidad con fecha y hora en la fecha en que se modificó por última vez, en comparación con la fecha en que se archivó. El primer README probablemente se creó a fines de la década de 1960, pero probar que es una tarea bastante difícil.

— Tim Post

@Tim: ¡un LÉAME en una pila de tarjetas perforadas!

— Martin Beckett

Encontré uno de noviembre de 1974 y marzo de 1975: programmers.stackexchange.com/questions/96966/origin-of-readme/…

— Hugo

10

Tomé una clase de Sistemas Operativos el año pasado y recuerdo que mi profesor me dijo que tenían README (archivos impresos físicos reales) para todas sus tarjetas perforadas y cinta magnética y casi cualquier otra cosa que fuera un "programa". En ese momento, realmente necesitabas uno debido al proceso laborioso que estaba involucrado con la creación, la ejecución y todo lo demás. Estos README a veces también incluían las impresiones reales de cómo se suponía que las tarjetas perforadas debían perforarse como una forma de verificación y depuración de errores.

Aparentemente, la convención también sigue el viejo sistema, ya que con todas las tarjetas perforadas se adjuntaba un "rollo" de papel con la declaración README en mayúsculas impresas, esto tenía todas las instrucciones de uso y carga de las tarjetas perforadas en el sistema .

Para una referencia de tiempo, esto habría sido en los años 60. Pero el sistema de tarjetas perforadas ha existido desde la década de 1700 para controlar telares "automatizados", por lo que tal vez sea tan antiguo como eso.

— Jeff Langemeier
fuente

8

Encontrado a través de este hilo alt.folklore.computers :

Apuesto a que algún documento que acompañe a uno de los sistemas operativos PDP-8 o paquetes de software probablemente sea el más antiguo.

El más antiguo que encontré en los archivos PDP-10 es el UCI LISP " READ.ME " de la cuarta cinta de la biblioteca DECUS, con una marca de tiempo del 27 de marzo de 1975 :

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

Desafortunadamente, muchos de los mini OS anteriores no admiten una marca de tiempo [única] en la estructura de directorio de la cinta o el disco, por lo que es difícil saber cuándo se editó un documento por última vez.

El archivo no solo tiene una marca de tiempo del 27 de marzo de 1975, sino que también está firmado y fechado en el archivo :

                    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

Editar: navegando por los archivos PDP-10 encontré un archivo README.TXT anterior del 27 de noviembre de 1974, con sello de tiempo y firmado en el archivo :

[README.TXT es el archivo DOC para SPICE / SINC / SLIC]

Esta cinta a prueba de fallas contiene los programas de análisis de circuitos:
    SPICE SINC and SLIC
descrito en el Boletín de software de aplicaciones Volumen 4.

requisitos:

SPICE requiere FORTRAN-10 versión 4 debido a su uso de datos Holerith ajustados a la derecha. Se ejecuta en aproximadamente 47K.

[...]

también incluye este archivo, los FOROTS para ir con los SAV y la fuente de SECOND.MAC, la rutina de sincronización. SPICE se divide en tres partes: 1SPICE.FOR, 2 y 3.

Hay un documento impreso para describir cada uno de los programas. Estos están incluidos en el paquete DECUS. La documentación y los programas fueron desarrollados originalmente por el departamento de EE de la Univ. de California en Berkley en un CDC 6400. Excepto para convertir el FORTRAN al DECsystem-10, no se han realizado cambios en los programas. Para los datos de prueba, SLIC y SINC han mostrado una ligera variación con respecto al 6400, SPICE no muestra variación.

¡Buena suerte! 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
fuente