Readme

Origem: Wikipédia, a enciclopédia livre.
Ir para: navegação, pesquisa
Ambox rewrite.svg
Esta página precisa ser reciclada de acordo com o livro de estilo (desde Fevereiro de 2008).
Sinta-se livre para editá-la para que esta possa atingir um nível de qualidade superior.

Introdução[editar | editar código-fonte]

Um arquivo readme (também read me, em português: leia-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.

O nome foi escolhido de forma que, mesmo uma pessoa que não sabe o que seria tipicamente um arquivo readme, seria levada a lê-lo em função do nome; além disso, o nome é gravado em caixa alta para que, em ambientes que preservam a diferença entre caixa alta e caixa baixa e usem uma ordenação ASCIIbetical, apareça próximo do início da listagem do diretório (já que, na ordenação ASCIIbetical, caixa alta precede caixa baixa).

Conteúdo[editar | editar código-fonte]

O conteúdo, tipicamente, inclui uma ou mais dentre as seguintes informações:


READMEs sem nome de readme[editar | editar código-fonte]

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:

README Informação Geral
AUTHORS Créditos
THANKS Agradecimentos
ChangeLog Detalhamento das mudanças desde a última versão (changelog), destinado a programadores
NEWS Relato básico das mudanças (changelog), destinado aos usuários
INSTALL Informações sobre a instalação
COPYING Informações sobre licenciamento e Copyright
BUGS Defeitos conhecidos e instruções sobre como denunciar novos

Outros arquivos frequentemente distribuídos com software incluem um FAQ e um TODO, este último listando possíveis mudanças futuras.

Outros usos[editar | editar código-fonte]

Readme também é o nome…