O que é o formato de ficheiro README?
Um arquivo .readme é um arquivo de documentação em texto simples que segue a convenção README da cultura Unix e de software de código aberto. A extensão .readme é uma variante incomum das formas tradicionais em maiúsculas README (sem extensão) e README.txt.
Arquivos README fornecem documentação introdutória legível por humanos para um pacote de software, projeto ou arquivo. O conteúdo típico inclui uma descrição do projeto, instruções de instalação e uso, informações do autor e um aviso de licença. Não há estrutura obrigatória - o conteúdo é composto por prosa e listas de formato livre.
O README em maiúsculas sem extensão remonta a pelo menos a década de 1970 em distribuições Unix, onde era convencionalmente o primeiro arquivo que se esperava que um usuário lesse; gerenciadores de pacotes e listagens de diretórios frequentemente o exibiam automaticamente. O README.txt tornou-se comum no Windows. Desde aproximadamente 2008, o README.md (Markdown) tornou-se a forma dominante porque o GitHub renderiza automaticamente o Markdown em páginas de repositório.
A extensão .readme é ocasionalmente encontrada em distribuições de shareware mais antigas e em certos gerenciadores de pacotes, mas não possui distinção técnica do .txt - ambos são texto simples que qualquer editor abre sem configuração. A codificação é tipicamente UTF-8 (moderna) ou ASCII (legada); as ferramentas do Windows podem produzir arquivos UTF-16 LE com um BOM, mas o UTF-8 é o padrão. O tamanho do arquivo é quase sempre inferior a 100 KB.
Segurança e proteção
RISCO: LOWArquivo de texto simples; sem código executável; completamente seguro para abrir em qualquer editor de texto.
Detalhes do formato
em resumoProgramas que abrem arquivos README
Windows3 apps
Windows Notepad
Integrado O clique duplo pode não funcionar (o SO pode não reconhecer a extensão .readme); clique com o botão direito → Abrir com → Bloco de Notas. 
Notepad
Código aberto Clique com o botão direito → Abrir com → Notepad++; ou arraste para a janela do Notepad++. 
Visual Studio Code
Código aberto Arquivo → Abrir Arquivo, selecione o arquivo .readme; exibido como texto simples. 
macOS2 apps
Visual Studio Code
Código aberto Arquivo → Abrir Arquivo, selecione o arquivo .readme; exibido como texto simples. 
Linux2 apps
Detalhes técnicos
especificação profunda| Codificação | UTF-8 (padrão moderno); ASCII (legado); ocasionalmente UTF-16 LE com BOM no Windows |
| Contêiner | Texto simples - sem invólucro binário, sem cabeçalho, sem esquema |
| Estrutura obrigatória | Nenhuma - prosa de formato livre; sem campos definidos ou ordem exigida |
| Variantes comuns de nome de arquivo | README (sem extensão), README.txt, README.md, .readme |
| Tipo MIME | text/plain |
| Tamanho típico de arquivo | Quase sempre inferior a 100 KB |
| Finais de linha | LF (Unix/macOS/Linux) ou CRLF (Windows); ambos aceitos por editores de texto |
| UTF-8 BOM | Opcional - possível em arquivos criados no Windows (prefixo EF BB BF) |
| Forma moderna dominante | README.md (Markdown), renderizado automaticamente pelo GitHub, GitLab e Bitbucket desde ~2008 |
| Exibição histórica | Exibido automaticamente por listagens de diretórios Unix antigas e gerenciadores de pacotes |
| Plataformas associadas | Todos os sistemas operacionais - Windows, macOS, Linux, Unix |
| Conteúdo típico | Descrição do projeto, instruções de instalação/uso, informações do autor, aviso de licença |
| Lançado | 1970s Unix tradition; .readme as a distinct extension less common than plain README or README.txt |
| Versão mais recente | N/A - no versioning |
| Padrão aberto | Sim · livre de royalties |
Conversões de README
Perguntas e Respostas da Comunidade
perguntado por usuáriosAinda não há perguntas - seja o primeiro a perguntar sobre arquivos README.
