Como formatar um arquivo “README”?

Se você é um desenvolvedor de sistemas e aplicativos, mesmo iniciante, já deve ter se perguntado como criar um arquivo README dentro dos padrões aceitáveis e esperados pelo mercado. A dúvida, muitas vezes cruel, como citou a acris, já tem uma resposta em bom português no wikipedia (traduzida por ela mesma do wikipédia em inglês).

De acordo com a tradução livre da acris, “Um arquivo readme (também read me) contém informação sobre outros arquivos num diretório ou arquivo e é comumente distribuído com softwares de computador. Este arquivo é usualmente um arquivo de texto chamado README.TXT, README.1ST, READ.ME ou simplesmente README, embora softwares como o Microsoft Windows possam incluir um README.WRI, README.RTF ou README.DOC.”

Ainda reproduzindo na íntegra o texto, “…A expressão “readme file” é também, algumas vezes, usada descritiva e genericamente para arquivos que não possuem nome “readme” mas são considerados espécies de arquivos readmes. A distribuição de código fonte de muitos pacotes de software livre, especialmente aqueles que seguem os Padrões Gnits ou aquele produzidos com a ferramenta GNU Autotools, freqüentemente incluem um conjunto padrão de arquivos readmes.”