En la distribución y el desarrollo de software , un archivo README contiene información sobre los otros archivos en un directorio o archivo de software de computadora . Una forma de documentación , generalmente es un archivo de texto simple llamado ,,,, [ 1 ] o ( para indicar el uso de Markdown )READMERead MeREAD.MEREADME.txtREADME.md
El nombre del archivo generalmente se escribe en mayúsculas. En sistemas tipo Unix en particular, esto hace que se destaque, tanto porque los nombres de archivos en minúsculas son más comunes como porque el lscomando comúnmente ordena y muestra archivos en orden de código ASCII , en el que los nombres de archivos en mayúsculas aparecerán primero. [nota 1]
Un archivo README normalmente abarca:
No está claro cuándo comenzó la convención de incluir un archivo README, pero se han encontrado ejemplos que datan de mediados de la década de 1970. [3] [4] [5] [6] [7] [8] [9] [ se necesita una mejor fuente ] El primer software del sistema Macintosh instalaba un Léame en el disco de inicio y los archivos LÉAME comúnmente acompañaban al software de terceros.
En particular, existe una larga historia de software gratuito y de código abierto que incluye un archivo README; Los estándares de codificación GNU alientan a incluir uno para proporcionar "una descripción general del paquete". [10]
Desde la aparición de la web como plataforma estándar de facto para la distribución de software , muchos paquetes de software han movido (u ocasionalmente copiado) algunos de los archivos auxiliares y piezas de información anteriores a un sitio web o wiki , incluyendo a veces el propio README, o a veces dejando solo un breve archivo README sin toda la información requerida por un nuevo usuario del software.
El popular sitio web de alojamiento de código fuente GitHub recomienda encarecidamente la creación de un archivo README: si existe uno en el directorio principal (de nivel superior) de un repositorio, se presenta automáticamente en la página principal del repositorio. [11] Además del texto sin formato, también se admiten otros formatos y extensiones de archivo , [12] y la conversión HTML tiene en cuenta las extensiones; en particular, a README.mdse trata como GitHub Flavored Markdown .
La expresión "archivo Léame" también se utiliza a veces de forma genérica, para otros archivos con un propósito similar. [ cita necesaria ] Por ejemplo, las distribuciones de código fuente de muchos paquetes de software gratuitos (especialmente aquellos que siguen los estándares Gnits o los producidos con GNU Autotools ) incluyen un conjunto estándar de archivos Léame:
También se distribuyen comúnmente con los paquetes de software un archivo de preguntas frecuentes y un TODOarchivo que enumera las mejoras planificadas.
Introducción a ojo de hacker tradicionalmente incluida en el directorio de nivel superior de una distribución fuente Unix, que contiene un puntero a documentación más detallada, créditos, historial de revisiones diversas, notas, etc. […] Cuando se les pregunta, los hackers invariablemente relacionan la convención README con la famosa escena de Las aventuras de Alicia en el país de las maravillas de Lewis Carroll en la que Alicia se enfrenta a bocadillos mágicos etiquetados "Cómeme" y "Bébeme".
[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 y SLIC descritos en el Boletín de software de aplicaciones Volumen 4. Requisitos: SPICE requiere FORTRAN-10 versión 4 debido a su uso de Datos de Holerith ajustados a la derecha. Se ejecuta en aproximadamente 47K. […] también incluye este archivo, los FOROTS que acompañan a los GUARDADOS y la fuente de SECOND.MAC, la rutina de cronometraje. 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 Berkeley en un CDC 6400. Excepto para convertir 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]
Los archivos de esta cinta FAILSAFE constituyen el sistema UCI LISP. Están documentados en su mayor parte en el Manual UCI LISP, disponible en el Departamento de Información y Ciencias de la Computación de la Universidad de California, Irvine, California.[1]
[…] tenían archivos README (archivos físicos impresos reales) para todas sus tarjetas perforadas y cintas magnéticas y prácticamente cualquier otra cosa que fuera un "programa". En ese momento realmente necesitabas uno debido al laborioso proceso que implicaba crearlo, ejecutarlo y todo lo demás. Estos archivos README a veces también incluían impresiones reales de cómo se suponía que debían perforarse las tarjetas perforadas como una forma de verificación y depuración de errores. Aparentemente, la convención también sigue el sistema antiguo en el sentido de que con todas las tarjetas perforadas se adjuntaba un "reem" de papel con la declaración README en mayúsculas impresa, este tenía todas las instrucciones para el uso y la carga de las tarjetas perforadas en el sistema. . Como referencia temporal, esto habría sido en los años 60. […]
Este artículo se basa en parte en Jergon File , que es de dominio público.