Coloque a 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 projeto, ex.: tecnologia usada, filosofia de existência, qual problema tenta resolver, etc.
IMPORTANTE: coloque aqui alguma mensagem que é muito relevante aos usuários do projeto, se existir.
Aqui você pode colocar uma captura de tela do produto resultante desse projeto. Descreva também suas funcionalidades usando uma lista:
- Fácil integração.
- Poucas dependências.
- Possui ótima documentação e testes.
Geralmente o primeiro passo para começar é instalar dependências para rodar o projeto. Execute:
sudo apt install dependencia
Coloque os comandos em linhas diferentes:
sudo apt install outra-dependencia
Dessa forma os usuários podem copiar e colar sem ler a documentação (que é o que geralmente acontece).
Geralmente os próximos passos ensinam como instalar e configurar o projeto para uso/desenvolvimento. Execute:
git clone https://github.com/OpenSourceLabUFV/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.
Lembre - se que as contribuições devem seguir nosso Código de Conduta.
Veja o arquivo ROADMAP.md para ter uma ideia dos próximos passos do projeto.
Esse projeto é licenciado nos termos da licença open-source MIT.
Abaixo está uma lista de links interessantes e projetos similares: