README

README
Text-x-readme.svg
Información general
Tipo de MIMEtext/x-readme
Formato abierto?

Un archivo README contiene información acerca de otros archivos en un directorio. Es una forma de documentación de software, usualmente en un archivo de texto plano llamado READ.ME, README.TXT, README.md (para un archivo markdown), README.1ST o simplemente README. En ocasiones, en español (y sobre todo en los años 90) puede venir traducido como LEEME.TXT.

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

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
Other Languages
العربية: اقرأني
čeština: Readme
Deutsch: Readme
English: README
فارسی: README
français: Readme
hrvatski: Readme
Bahasa Indonesia: README
italiano: README
日本語: リードミー
한국어: 리드미
lietuvių: Readme
Nederlands: README
polski: Readme
português: Readme
русский: README-файл
srpskohrvatski / српскохрватски: Readme
українська: README-файл
中文: Readme