¿Qué es el formato de archivo README?
Un archivo .readme es un archivo de documentación en texto plano que sigue la convención README de la cultura de Unix y del software de código abierto. La extensión .readme es una variante poco común de las formas tradicionales README en mayúsculas (sin extensión) y README.txt.
Los archivos README proporcionan documentación introductoria legible por humanos para un paquete de software, proyecto o archivo. El contenido típico incluye una descripción del proyecto, instrucciones de instalación y uso, información del autor y un aviso de licencia. No existe una estructura obligatoria: el contenido es prosa y listas de formato libre.
El README en mayúsculas sin extensión se remonta al menos a la década de 1970 en las distribuciones de Unix, donde convencionalmente era el primer archivo que se esperaba que leyera un usuario; los gestores de paquetes y los listados de directorios a menudo lo mostrabann automáticamente. README.txt se volvió común en Windows. Desde aproximadamente 2008, README.md (Markdown) se ha convertido en la forma dominante porque GitHub renderiza automáticamente Markdown en las páginas de los repositorios.
La extensión .readme se encuentra ocasionalmente en distribuciones antiguas de shareware y en ciertos gestores de paquetes, pero no conlleva ninguna distinción técnica de .txt; ambos son texto plano que cualquier editor abre sin configuración. La codificación suele ser UTF-8 (moderna) o ASCII (heredada); las herramientas de Windows pueden producir archivos UTF-16 LE con un BOM, pero UTF-8 es el estándar. El tamaño del archivo es casi siempre inferior a 100 KB.
Seguridad y protección
RIESGO: LOWArchivo de texto plano; sin código ejecutable; completamente seguro de abrir en cualquier editor de texto.
Detalles del formato
en pocas palabrasProgramas que abren archivos README
Detalles técnicos
especificación profunda| Codificación | UTF-8 (estándar moderno); ASCII (heredado); ocasionalmente UTF-16 LE con BOM en Windows |
| Contenedor | Texto plano: sin envoltorio binario, sin encabezado, sin esquema |
| Estructura obligatoria | Ninguna: prosa de formato libre; sin campos definidos ni orden requerido |
| Variantes comunes de nombre de archivo | README (sin extensión), README.txt, README.md, .readme |
| Tipo MIME | text/plain |
| Tamaño de archivo típico | Casi siempre inferior a 100 KB |
| Finales de línea | LF (Unix/macOS/Linux) o CRLF (Windows); ambos aceptados por editores de texto |
| BOM UTF-8 | Opcional: posible en archivos creados en Windows (prefijo EF BB BF) |
| Forma moderna dominante | README.md (Markdown), renderizado automáticamente por GitHub, GitLab y Bitbucket desde ~2008 |
| Visualización histórica | Mostrado automáticamente por los primeros listados de directorios de Unix y gestores de paquetes |
| Plataformas asociadas | Todos los sistemas operativos: Windows, macOS, Linux, Unix |
| Contenido típico | Descripción del proyecto, instrucciones de instalación/uso, información del autor, aviso de licencia |
| Lanzado | 1970s Unix tradition; .readme as a distinct extension less common than plain README or README.txt |
| Última versión | N/A - no versioning |
| Estándar abierto | Sí · libre de regalías |
Conversiones de README
Preguntas y respuestas de la comunidad
preguntado por usuariosAún no hay preguntas; sea el primero en preguntar sobre los archivos README.