LÉAME
Un archivo README contiene información sobre los otros archivos en un directorio o archivo de software de computadora . Una forma de documentación , por lo general es un archivo de texto simple llamado , , , , [1] (para indicar el uso de Markdown ), o . [2]READMERead MeREAD.MEREADME.TXT README.mdREADME.1ST
El nombre del archivo generalmente se escribe en mayúsculas. En los sistemas similares a Unix en particular, esto hace que se destaque, tanto porque los nombres de archivo en minúsculas son más comunes como porque el lscomando comúnmente ordena y muestra los archivos en orden de código ASCII , en el que los nombres de archivo en mayúsculas aparecerán primero. [nota 1]
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. [4] [5] [6] [7] [8] [9] [2] [ se necesita una mejor fuente ] El software del sistema Macintosh anterior instalaba un Léame en el disco de inicio y los archivos LÉAME solían acompañar al software de terceros.
En particular, existe una larga historia de software libre y software de código abierto que incluye un archivo README; los estándares de codificación de GNU alientan a incluir uno para proporcionar "una descripción general del paquete". [10]
Desde el advenimiento de la web como una plataforma estándar de facto para la distribución de software , muchos paquetes de software han movido (o, en ocasiones, copiado) algunos de los archivos auxiliares anteriores y piezas de información a un sitio web o wiki , a veces incluyendo el propio README, o a veces dejando solo un breve archivo LÉAME 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 (nivel superior) de un repositorio, se presenta automáticamente en la página principal del repositorio. Además del texto sin formato, también se admiten varios otros formatos y extensiones de archivo , [11] y la conversión de HTML tiene en cuenta las extensiones; en particular, a README.mdse trata como GitHub Flavored Markdown .
