Como ler um arquivo README.md no Android
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:
- Você baixou um projeto em um arquivo zip
- Alguém enviou o README para você
- O projeto está em um servidor ou nuvem que mostra os arquivos como texto puro
- Você quer ler offline, no metrô ou no avião
Abrir um README.md no Android
- Instale um visualizador de markdown. Usamos o MD Reader.
- Abra o aplicativo Arquivos, encontre o arquivo
README.md, toque nele e escolha o MD Reader. - Ou abra o MD Reader, toque em Abrir arquivo e selecione o README.
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:
- Blocos de código com destaque de sintaxe e botão para copiar com um toque, ótimo para comandos de instalação. Veja como ler blocos de código no celular.
- Tabelas de opções e parâmetros, que rolam para os lados quando são largas.
- Listas de tarefas de itens do projeto.
- Diagramas Mermaid da arquitetura. Veja diagramas Mermaid no Android.
- Notas de destaque como
> [!WARNING]. - Um sumário criado a partir dos títulos, para você ir direto para a parte de instalação.
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.