¿Qué es un archivo README?

Un archivo Léame es un archivo de texto que a menudo se incluye con el software que contiene información general o instrucciones sobre el software. La naturaleza específica de esta información varía significativamente de un archivo a otro; un archivo Léame puede contener instrucciones de instalación, información general sobre el uso del software, términos de servicio y otra información legal, o cualquier otra información relevante para el software. Casi todos los archivos léame incluyen al menos el nombre y la versión del software, el nombre de la empresa o persona que desarrolló el software y la fecha de publicación. Sin embargo, no existe una fórmula general para escribir un archivo Léame, y al final el contenido depende de los caprichos del desarrollador.

El nombre "readme" está destinado a llamar la atención del usuario sobre el archivo, ya que a menudo incluye la información necesaria para operar correctamente el software. En muchos casos, el nombre del archivo Léame se pondrá en mayúscula y se llamará "README.txt" o algo similar. Algunos directorios de programas mueven los nombres de los archivos en mayúscula a la parte superior de cualquier lista de archivos, por lo que las mayúsculas otorgan importancia al archivo léame y nuevamente alienta al usuario del software a leer el archivo antes de usar el programa. Algunos archivos Léame se titulan "léame primero" o algo similar para alentar a los lectores a leer la documentación antes de ejecutar el software.

Un archivo Léame puede contener muchos tipos diferentes de información de diversa importancia. Además de los nombres y las versiones de los archivos, que generalmente se incluyen, los archivos Léame también suelen incluir un historial de versiones o un registro de cambios que enumera los cambios realizados en el software a lo largo del tiempo. Un archivo Léame también puede incluir una lista de problemas o errores conocidos que afectan el uso del software. Algunos incluyen información menos esencial, como agradecimientos o mensajes personales del equipo de desarrollo. Para programas particularmente simples, el archivo Léame puede en realidad servir como un manual del usuario que instruye a uno sobre el uso general del software.

Los archivos Léame elaborados son muy raros, ya que los desarrolladores generalmente prefieren presentar la información necesaria de una manera simple, clara y concisa. Un archivo Léame generalmente se presenta en formato de texto plano con una fuente estándar y sin imágenes a menos que el desarrollador sienta que es necesario algo más elaborado. Esta simplicidad elimina distracciones innecesarias y mantiene al lector enfocado en la información. A veces, un archivo Léame se presenta en un formato de "preguntas frecuentes" o preguntas frecuentes. En dicho formato, el desarrollador predice las preguntas más comunes que las personas pueden tener sobre el software y proporciona respuestas claras y simples en lugar de presentar toda la información técnica en un bloque de texto que las personas no pueden leer.