Cómo leer un archivo README.md en Android
README.md es el archivo que explica un proyecto de software: qué hace, cómo instalarlo y cómo usarlo. Está escrito en markdown, por lo que en un teléfono suele abrirse como texto plano o no abrirse en absoluto.
Archivos README en GitHub
Si el proyecto está en GitHub, el sitio web de GitHub ya muestra el README formateado. Solo abre la página del repositorio en tu navegador. Solo necesitas un visor cuando tienes el archivo en sí, por ejemplo:
- Descargaste un proyecto como archivo zip
- Alguien te envió el README
- El proyecto está en un servidor o disco que muestra los archivos como texto plano
- Quieres leerlo sin conexión, en un tren o en un avión
Abrir un archivo README.md en Android
- Instala un visor de markdown. Usamos MD Reader.
- Abre Files, busca
README.md, tócalo y elige MD Reader. - O abre MD Reader, toca Abrir archivo y selecciona el README.
Desde un archivo zip: La aplicación Files de Android (Archivos de Google) puede extraer archivos zip. Toca el zip, elige Extraer y luego abre README.md desde la carpeta extraída.
Desde un enlace directo (raw): Si abres un enlace directo a un README en tu navegador, este muestra texto plano. Mantén presionado, selecciona Seleccionar todo, Copiar y luego usa Pegar del portapapeles en MD Reader.
Qué verás
Los archivos README usan más formato que la mayoría de los documentos. MD Reader muestra:
- Bloques de código con resaltado de sintaxis y botón de copia con un toque, muy útil para comandos de instalación. Consulta leer bloques de código en el móvil.
- Tablas de opciones y flags, con desplazamiento horizontal cuando son anchas.
- Listas de tareas de elementos de la hoja de ruta.
- Diagramas Mermaid de la arquitectura. Consulta diagramas Mermaid en Android.
- Notas y avisos (Callouts) como
> [!WARNING]. - Un índice (Contents) creado a partir de los títulos, para que puedas saltar directamente a "Instalación".
Acerca de los enlaces e imágenes
Los enlaces a sitios web se abren en tu navegador. Los enlaces a otros archivos del proyecto (como docs/setup.md) necesitan toda la carpeta, así que abre esos archivos por separado por ahora. Las imágenes que apuntan a la web necesitan internet para cargarse. MD Reader no solicita acceso a internet, por lo que las imágenes remotas no se cargarán. El texto alrededor de ellas se sigue leyendo perfectamente.