Coloque uma descrição do projeto aqui. Geralmente essa descrição tem de duas a três linhas de tamanho. Ela deve dar uma visão geral sobre o que é o projeto, ex.: tecnologia usada, filosofia de existência, qual problema tenta-se resolver, etc. Se você precisa escrever mais que 3 linhas de descrição, crie subseções.

IMPORTANTE: coloque aqui alguma mensagem que é muito relevante aos usuários do projeto, se for o caso.

Aqui você pode colocar uma screenshot do produto resultante desse projeto. Descreva também suas features usando uma lista:

• Fácil integração;
• Poucas dependências;
• Utiliza um template lindo para organizar o README;
• Possui ótima documentação e testes.

Geralmente o primeiro passo para começar é instalar dependências para rodar o projeto. Rode:

apt get install dependencia

Recomenda-se que cada comando seja colocado em uma linha diferente:

apt get install outra-coisa

Dessa forma os usuários podem copiar e colar sem ler as documentação (que é o que geralmente acontece).

Geralmente os próximos passos ensinam como instalar e configurar o projeto para uso/desenvolvimento. Rode:

git clone https://github.com/ccuffs/template template

Sua ajuda é muito bem-vinda, independente da forma! Confira o arquivo CONTRIBUTING.md para conhecer todas as formas de contribuir com o projeto. Por exemplo, sugerir uma nova funcionalidade, reportar um problema/bug, enviar um pull request, ou simplemente utilizar o projeto e comentar sua experiência.

Veja o arquivo ROADMAP.md para ter uma ideia de como o projeto deve evoluir.

Esse projeto é licenciado nos termos da licença open-source Apache 2.0 e está disponível de graça.

Veja todas as alterações desse projeto no arquivo CHANGELOG.md.

Abaixo está uma lista de links interessantes e projetos similares:

• Outro projeto
• Projeto inspiração
• Ferramenta semelhante