MD Reader

Como ler um arquivo README.md no Android

Atualizado:

O arquivo README.md é o documento que explica um projeto de software: o que ele faz, como instalar e como usar. Ele é escrito em markdown, então no celular costuma abrir como texto puro ou nem abrir.

Arquivos README no GitHub

Se o projeto está no GitHub, o site já mostra o README formatado. Basta abrir a página do repositório no navegador. Você só precisa de um visualizador quando tem o arquivo em si, por exemplo:

Abrir um README.md no Android

  1. Instale um visualizador de markdown. Usamos o MD Reader.
  2. Abra o aplicativo Arquivos, encontre o arquivo README.md, toque nele e escolha o MD Reader.
  3. Ou abra o MD Reader, toque em Abrir arquivo e selecione o README.

Disponível no Google Play

De um arquivo zip: O aplicativo Arquivos do Android consegue extrair arquivos zip. Toque no zip, escolha Extrair e abra o README.md na pasta extraída.

De um link raw: Se você abrir um link raw de README no navegador, ele mostrará texto simples. Pressione e segure, selecione Selecionar tudo, Copiar e use Colar da área de transferência no MD Reader.

O que você verá

Os arquivos README usam mais formatação do que a maioria dos documentos. O MD Reader mostra:

Sobre links e imagens

Links para sites abrem no seu navegador. Links para outros arquivos no projeto (como docs/setup.md) precisam da pasta inteira, então abra esses arquivos separadamente por enquanto. Imagens que apontam para a web precisam de internet para carregar. O MD Reader não pede acesso à internet, então imagens remotas não vão carregar. O texto ao redor continua legível.