O que é um arquivo README?

Um arquivo leia-me é um arquivo de texto geralmente incluído no software que contém informações ou instruções gerais sobre o software. A natureza específica dessas informações varia significativamente de arquivo para arquivo; um arquivo leia-me pode conter instruções de instalação, informações gerais de uso de software, termos de serviço e outras informações legais ou qualquer outra informação relevante para o software. Quase todos os arquivos leia-me incluem pelo menos o nome e a versão do software, o nome da empresa ou indivíduo que desenvolveu o software e a data de publicação. Entretanto, não existe uma fórmula geral para escrever um leia-me e, no final, o conteúdo depende dos caprichos do desenvolvedor.

O nome "leia-me" destina-se a chamar a atenção do usuário para o arquivo, pois muitas vezes inclui as informações necessárias para operar corretamente o software. Em muitos casos, o nome de arquivo de um arquivo leia-me será maiúsculo e será chamado de "README.txt" ou algo semelhante. Alguns diretórios de programas movem nomes de arquivos em maiúsculas para o topo de qualquer lista de arquivos, portanto, a maiúscula confere destaque ao arquivo leia-me e incentiva novamente o usuário do software a ler o arquivo antes de usar o programa. Alguns arquivos leia-me são realmente intitulados "leia-me primeiro" ou algo semelhante para incentivar ainda mais os leitores a examinar a documentação antes de executar o software.

Um arquivo leia-me pode conter muitos tipos diferentes de informações de importância variável. Além dos nomes e versões dos arquivos, geralmente incluídos, os arquivos leia-me também incluem frequentemente um histórico de versões ou um registro de alterações que lista as alterações feitas no software ao longo do tempo. Um leia-me também pode incluir uma lista de problemas ou bugs conhecidos que afetam o uso do software. Alguns incluem informações menos essenciais, como agradecimentos ou mensagens pessoais da equipe de desenvolvimento. Para programas particularmente simples, o arquivo leia-me pode realmente servir como um manual do usuário que instrui um no uso geral do software.

Arquivos leia-me elaborados são muito raros, pois os desenvolvedores geralmente preferem dispor as informações necessárias de maneira simples, clara e concisa. Um arquivo leia-me geralmente é apresentado em um formato de texto sem formatação com uma fonte padrão e sem imagens, a menos que o desenvolvedor sinta que algo mais elaborado é necessário. Essa simplicidade remove distrações desnecessárias e mantém o leitor focado nas informações. Às vezes, um arquivo leia-me é apresentado em um formato "perguntas freqüentes" ou FAQ. Nesse formato, o desenvolvedor prevê as perguntas mais comuns que as pessoas podem ter sobre o software e fornece respostas claras e simples, em vez de apresentar todas as informações técnicas em um bloco de texto que as pessoas podem não querer ler.