Readme

Um arquivo Readme (às vezes escrito README) é um arquivo de texto que fornece documentação básica para um programa de software. Ele geralmente acompanha ou é instalado pelo instalador de um programa. A maioria dos arquivos Readme é composta por texto simples, embora alguns possam incluir imagens ou vídeos.

Os arquivos Readme normalmente incluem algumas categorias de informações. A maioria contém instruções para configurar e usar o programa, especialmente se ele exigir etapas que podem não ser intuitivas. Eles também exibem informações de direitos autorais e créditos dos desenvolvedores, permitindo que os usuários saibam quem participou do desenvolvimento do programa. Arquivos Readme abrangentes também incluem etapas de solução de problemas para lidar com problemas comuns e um registro de alterações com atualizações recentes, correções de bugs e patches.

Agora que quase toda a distribuição de software acontece pela Internet, as informações apresentadas em um arquivo Readme também costumam estar no site do programa. Isso permite que o desenvolvedor do programa atualize as informações com frequência e forneça um registro de alterações que o usuário possa consultar antes de fazer uma atualização. O desenvolvedor pode até criar uma documentação mais abrangente com a ajuda da comunidade de usuários do programa usando um software Wiki.