MD Reader

Cómo leer un archivo README.md en Android

Actualizado:

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:

Abrir un archivo README.md en Android

  1. Instala un visor de markdown. Usamos MD Reader.
  2. Abre Files, busca README.md, tócalo y elige MD Reader.
  3. O abre MD Reader, toca Abrir archivo y selecciona el README.

Disponible en Google Play

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:

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.