README

De Wikipedia, la enciclopedia libre
Saltar a: navegación, búsqueda
README
Text-x-readme.svg
Información general
Tipo de MIME text/x-readme
Formato abierto ?
[editar datos en Wikidata]

Un archivo README contiene información acerca de otros archivos en un directorio. Es una forma de documentación de softvare, usualmente en un archivo de texto plano llamado READ.ME, README.TXT, README.md (para un archivo markdown), README.1ST o simplemente README.

El nombre del archivo es generalmente escrito en mayúsculas. En los sistemas Unix-like generalmente los nombres se escriben en minúscula, y esto hace que en un listado de archivos salga primero el archivo README.

Contenido[editar]

Típicamente contienen una o más de estos temas:

  • Instrucciones de configuración
  • Instrucciones de instalación
  • Instrucciones de operación
  • Un manifiesto de archivos
  • Información sobre la licencia
  • Información sobre el desarrollador
  • Bugs conocidos[1]
  • Solución de problemas[1]
  • Créditos y agradecimientos
  • Un registro de cambios
  • Una sección de noticias

Historia[editar]

It is unclear when the convention began, but there are examples dating back to the mid 1970s.[2][3]Plantilla:Expand section

A README file is a requirement in the GNU Coding Standards[4]​ Since the advent of the web as a de facto standard platform for software distribution, many software packages have moved (or occasionally, copied) some of the above ancillary files and pieces of information to a website or wiki, sometimes including the README itself, or sometimes leaving behind only a brief README file without all of the information required by a new user of the software. However, the popularity of GitHub (as well as older community conventions) has contributed towards README files still being widely used in open-source software (see next section).

En GitHub[editar]

En GitHub, si un repositorio Git tiene un archivo README en su directorio raíz, es automáticamente convertido en HTML y presentado en la página principal. Muchas extensiones de archivo pueden ser usadas, [5]​ y la conversión a HTML se realiza tomando en cuenta la extensión del archivo. Por ejemplo, un "README.md" podría ser tratado como un documento de Markdown de GitHub.

Como un término genérico[editar]

La locución "archivo readme" es usada genéricamente en ocasiones, para archivos con un propósito similar. Por ejemplo, el código fuente de las distribuciones de muchos paquetes de software libre, especialmente aquellos que siguen los Gnits Standards, o aquellos producidos por GNU Autotools, incluyen un conjunto estándar de archivos readme:

README Información general
AUTHORS Créditos
THANKS Agradecimentos
CHANGELOG Un registro de cambios detallado, para desarrolladores
NEWS Un registro de cambios básico, para usuarios
INSTALL Instrucciones de instalación
COPYING / LICENSE Información de licencia
BUGS ERrores conocidos, y la manera de informarlos

Otros archivos distribuidos también incluyen los archivos FAQ and a TODO, que incluyen las preguntas frecuentes, y futuras novedades, respectivamente.

Referencias[editar]