A template to make good README.md

README-Template.md

Título do Projeto

Isso é um parágrafo que introduz e explica brevemente o problema. No more.

Primeiros passos

Siga estes passos caso queira ter uma cópia do projeto configurada e executando no seu host local para propósitos de desenvolvimento e testes. Veja a seção Realizando Deploy para entender como fazer a instalação em um ambiente de produção.

Prerequisitos

Como instalar os requisitos?

Cite exemplos

Instalando

Um série de pasos com exemplo que mostram como obter o ambiente de desenvolvimento rodando.

Diga do que consiste o passo

Cite exemplos

E repita

Até acabar

Finalize com um exemplo de como obter alguma saída do sistema ou usar ele para uma pequena demonstração.

Executando os testes

Explore sobre como executar os testes automáticos para o sistema

Divida entre testes de funcionalidade

Explique o que esse teste faz e o motivo

Dê um exemplo

E teste de estilo de código

Explique o que esse teste faz e o motivo

Dê um exemplo

Realizando Deploy

Adicione notas adicionais sobre como dar deploy da aplicação em uma plataforma

Ferramentas de Build

• Dropwizard - The web framework used
• Maven - Dependency Management
• ROME - Used to generate RSS Feeds

Constribuindo

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versionamento

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

Autores

• Billie Thompson - Initial work - PurpleBooth

See also the list of contributors who participated in this project.

Licensa

This project is licensed under the MIT License - see the LICENSE.md file for details

Referências

• Hat tip to anyone whose code was used
• Inspiration
• etc