¿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 la 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 «Léame» pretende llamar la atención del usuario sobre el archivo, ya que a menudo incluye información necesaria para operar correctamente el software. En muchos casos, el nombre del archivo Léame se escribirá en mayúsculas y se llamará “README.txt” o algo similar. Algunos directorios de programas mueven los nombres de archivo en mayúsculas a la parte superior de cualquier lista de archivos, por lo que las mayúsculas dan protagonismo al archivo Léame y nuevamente alienta al usuario del software a leer el archivo antes de usar el programa. Algunos archivos Léame en realidad se titulan «Léame primero» o algo similar para animar aún más a los lectores a revisar 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 reconocimientos o mensajes personales del equipo de desarrollo. Para programas particularmente simples, el archivo Léame puede servir como un manual del usuario que instruye a uno en 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 un formato de texto sin formato 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 FAQ. En tal 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 colocar toda la información técnica en un bloque de texto que la gente puede no estar dispuesta a leer.