Quando usar

Comece por este modelo quando você publica uma biblioteca, uma ferramenta de linha de comando ou um serviço interno e precisa de uma documentação que responda às três primeiras perguntas: o que é, como instalar e como executar. Desenvolvedores e revisores leem, e também os clientes que recebem o README em PDF em um pacote de entrega.

O que tem dentro

• Um título formado a partir de um campo de preenchimento para o nome do seu projeto, com uma descrição de uma frase abaixo.
• Seções de instalação e uso, cada uma com um bloco de código para um comando de shell ou um exemplo de código.
• Uma seção de contribuição que orienta as pessoas a abrir uma issue antes de uma mudança grande.

Dicas para um documento melhor

• Teste o comando de instalação em uma máquina limpa antes de publicar. Um README que falha no primeiro passo perde a maioria dos leitores.
• Este modelo usa por padrão o estilo Técnico, que define os blocos de código em uma fonte monoespaçada e mantém linhas longas dentro da página ao exportar.