Un archivo README contiene información sobre otros archivos en un directorio o archivo de software de computadora . Una forma de documentación , por lo general es un simple texto sin formato archivo llamado , , [1] , [2] [1] [1] (para un archivo de texto mediante reducción del precio marcado), [1] - o simplemente . [1]Read Me
READ.ME
README.TXT
README.md
README.1ST
README
El nombre del archivo generalmente se escribe en mayúsculas. En sistemas similares a Unix en particular, esto hace que se note fácilmente, tanto porque los nombres de archivo en minúsculas son más comunes, como porque tradicionalmente el comando ls clasifica y muestra archivos en orden de código ASCII , de modo que los nombres de archivo en mayúsculas aparecen primero. [nb 1]
Contenido
Los contenidos suelen incluir uno o más de los siguientes:
- Instrucciones de configuración
- Instrucciones de instalación
- Instrucciones de operación
- Un manifiesto de archivo (lista de archivos incluida)
- Información sobre derechos de autor y licencias
- Información de contacto del distribuidor o programador
- Errores conocidos [3]
- Solución de problemas [3]
- Créditos y reconocimientos
- Un registro de cambios (generalmente para programadores)
- Una sección de noticias (generalmente para usuarios)
Historia
No está claro cuándo comenzó la convención, pero hay ejemplos que se remontan a mediados de la década de 1970. [4] [5] [6] [7] [8] [9] [1] [se necesita una fuente mejor ] El software del sistema Macintosh anterior instalaba un archivo Léame en el disco de inicio y, por lo general, acompañaba 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 GNU . [10] animar a incluir uno para proporcionar "una descripción general del paquete".
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 (u ocasionalmente, han copiado) algunos de los archivos auxiliares y piezas de información anteriores a un sitio web o wiki , a veces incluido el propio README, o a veces dejando solo un breve archivo README sin toda la información requerida por un nuevo usuario del software.
En tiempos más recientes, el popular repositorio Git propietario de GitHub [11] recomienda encarecidamente un archivo README: si se incluye uno en el directorio principal (nivel superior), se presenta automáticamente en la página web principal. Si bien se admite el texto sin formato tradicional, también se admiten varias extensiones y formatos de archivo diferentes, [12] y la conversión a HTML tiene en cuenta la extensión del archivo; en particular, un archivo "README.md" se trataría como un GitHub Flavored Archivo de rebajas .
Como término genérico
La expresión "archivo Léame" también se utiliza a veces de forma genérica, para archivos con un propósito similar. [ cita requerida ] Por ejemplo, las distribuciones de código fuente de muchos paquetes de software libre , especialmente los que siguen los Estándares de Gnits o los producidos con GNU Autotools , incluyen un conjunto estándar de archivos Léame:
README
Información general AUTHORS
Créditos THANKS
Expresiones de gratitud CHANGELOG
Un registro de cambios detallado, destinado a programadores NEWS
Un registro de cambios básico, destinado a los usuarios INSTALL
Instrucciones de instalación COPYING
/LICENSE
Información sobre derechos de autor y licencias BUGS
Errores conocidos e instrucciones para informar de nuevos CONTRIBUTING
/HACKING
Guía para posibles contribuyentes al proyecto
Otros archivos comúnmente distribuidos con software incluyen preguntas frecuentes y un TODO
archivo con una lista de posibles cambios futuros.
Ver también
- FILE_ID.DIZ
- DESCRIPCIÓN
- WHATSNEW.TXT
- .nfo
- página man
Notas
- ^ A menudo, este ya no es el caso, pero LC_ALL = C ls mostrará el comportamiento anterior.
Referencias
- ↑ a b c d e f Abdelhafith, Omar (13 de agosto de 2015). "README.md: Historia y componentes" . Archivado desde el original el 25 de enero de 2020 . Consultado el 25 de enero de 2020 .
- ^ Raymond, Eric Steven (1996). El diccionario del nuevo hacker . MIT Press . págs. 378–79. ISBN 978-0-26268092-9.
Introducción de 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, notas, etc. […] Cuando se les pregunta, los hackers relacionan invariablemente la convención README con la Escena famosa en Alicia en el país de las maravillas de Lewis Carroll en la que Alicia se enfrenta a munchies mágicos etiquetados como "Cómeme" y "Bébeme".
- ^ a b Manes, Stephen (noviembre de 1996). "¿README? Seguro, ¡antes de comprar!". PC World . 14 (11): 366.
- ^ "Archivo PDP-10: decus / 20-0079 / readme.txt from decus_20tap3_198111" . pdp-10.trailing-edge.com . 1974-11-27 . Consultado el 3 de marzo de 2018 .
[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 para acompañar a los SAVes y la fuente para 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. of Calif. en Berkeley 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 [final de README.TXT]
- ^ "DECUS 10-LIB-4 contiene 10-210 a 10-241, excepto 10-223" . pdp-10.trailing-edge.com . 1975-03-27 . Consultado el 3 de marzo de 2018 .
Los archivos de esta cinta FAILSAFE constituyen el sistema UCI LISP. Están documentados en su mayor parte en el Manual LISP de la UCI, disponible en el Departamento de Información y Ciencias de la Computación de la Universidad de California, Irvine, California.
[1] - ^ "Banco de trabajo del programador / sys / source / lex / README" . Julio de 1977 . Consultado el 25 de enero de 2020 .
- ^ "7ª edición de Unix / usr / doc / README" . 1979 . Consultado el 25 de enero de 2020 .
- ^ "Primer BSD de 32 bits usr / doc / README" . Marzo de 1980 . Consultado el 25 de enero de 2020 .
- ^ Langemeier, Jeff (29 de julio de 2011). "Re: Origen de README" . Consultado el 25 de enero de 2020 a través de Stackexchange.
[…] Tenían READMEs (archivos físicos impresos reales) para todas sus tarjetas perforadas y cinta magnética y prácticamente cualquier otra cosa que fuera un "programa". En ese momento, realmente lo necesitabas debido al laborioso proceso que implicaba la creación, ejecución y todo lo demás. Estos READMEs a veces también incluían las impresiones reales de cómo se suponía que debían perforarse las tarjetas perforadas como una forma de verificación de errores y depuración. Aparentemente, la convención también sigue el sistema antiguo en el que con todas las tarjetas perforadas se adjuntaba un "reem" de papel con la declaración README impresa en mayúsculas, que 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. […]
- ^ "Estándares de codificación GNU: versiones" . www.gnu.org . Consultado el 3 de marzo de 2018 .
- ^ "El sitio de código compartido Github cumple cinco años y llega a 3,5 millones de usuarios, 6 millones de repositorios" . TheNextWeb.com. 2013-04-11 . Consultado el 11 de abril de 2013 .
- ^ "Marcado" . GitHub . GitHub. 2014-12-25 . Consultado el 8 de febrero de 2015 .
Otras lecturas
- Johnson, Mark (1 de febrero de 1997). "Construyendo un Léame mejor". Comunicación técnica . Sociedad de Comunicación Técnica . 44 (1): 28–36. JSTOR 43089849 . [2] [3]
- Rescigno, Jeanne (agosto de 1997). "Buena elección de hipertexto para archivos README". Comunicación técnica . Sociedad de Comunicación Técnica . 44 (3): 214. JSTOR 43089876 .
- Livingston, Brian (14 de septiembre de 1998). "Verifique sus archivos Léame para evitar problemas comunes de Windows" . InfoWorld . Vol. 20 no. 37. InfoWorld Media Group, Inc. p. 34. Archivado desde el original el 18 de noviembre de 2006 . Consultado el 4 de junio de 2019 . [4]
- Benjamin, Andrew (15 de septiembre de 1996) [1993]. Escrito en el Departamento de Filosofía de la Universidad de Warwick , Reino Unido. Guédon, Jean-Claude (ed.). "Readme: Writing Notes - Meditaciones sobre la temporalidad de la escritura" . Surfaces (Revista electrónica) (en inglés y francés). Universidad de Montreal , Montreal (Quebec), Canadá: Les Presses de l'Université de Montréal . III (12): 1–12. ISSN 1188-2492 . Archivado desde el original el 20 de febrero de 2006 . Consultado el 4 de junio de 2019 . [5]
Este artículo se basa en parte en el archivo de jerga , que es de dominio público.