Um template para fazer um bom README.md

README-Template.md

Título do Projeto

Um parágrafo da descrição do projeto aqui

Começando

Essas instruções fornecerão uma cópia do projeto em execução na sua máquina local para fins de desenvolvimento e teste. Consulte implantação para obter notas sobre como implantar o projeto em um sistema ativo.

Pré-requisitos

Que coisas você precisa para instalar o software e como instalá-los

Dar exemplos

Instalando

Uma série de exemplos passo a passo que mostram como obter um ambiente de desenvolvimento em execução Diga qual etapa vai ser

Dê o exemplo

E repita

até terminar

Termine com um exemplo de como retirar alguns dados do sistema ou usá-los para uma pequena demonstração

Rodando os testes

Explique como executar os testes automatizados para este sistema

Divida em testes de ponta a ponta

Explique o que esse testes testam e por que

Dê um exemplo

E codificando testes de estilo

Explique o que esses testes testam e por que

Dê um exemplo

Implementação

Adicione notas adicionais sobre como fazer implementação disso em um sistema

Desenvolvido com

• Dropwizard - O framework web usado
• Maven - Gerenciamento de dependências
• ROME - Usado para gerar os feeds RSS

Contribuindo

Leia o CONTRIBUTING.md para detalhes do nosso código de conduta, e o processo para submissão de pull requests para nós.

Versionamento

Nós usamos SemVer para versionamento. Para as versões disponíveis, veja o tags neste respositório.

Autores

• Billie Thompson - Trabalho inicial - PurpleBooth

Veja também a lista de contribuidores que participaram nesse projeto.

Licensa

Esse projeto é licenciado pela licença do MIT - veja o arquivo LICENSE.md para detalhes

Agradecimentos

• Gorjeta de chapéu para qualquer pessoa cujo código foi usado
• Inspiração
• etc