Um template para escrever um bom README.md

README-Template.md

Título do Projeto

Um parágrafo com a descrição do projeto

Guia

Através dessas instruções você irá obter uma cópia do projeto e poderá executá-lo em sua máquina, para propósitos de desenvolvimento e teste. Leia as notas de deploy para descobrir como fazer deploy em produção.

Pré-requisitos

O que é necessário para instalar o software e como fazê-lo.

Dê exemplos

Instalação

Um série de exemplos passo a passo que mostram como configurar o ambiente de desenvolvimento.

Descreva o passo

Dê um exemplo

E repita

Até concluir

Termine dando um exemplo de utilização do software.

Executando os testes

Explique como executar os testes automatizados para este software.

Testes end to end

Explique o que estes testes fazem e por quê

Dê um exemplo

E testes de estilo de codificação

Explique o que estes testes fazem e por quê

Dê um exemplo

Processo de Deploy

Notas adicionais sobre como colocar o software em produção

Construído com

• Dropwizard - O framework web utilizado
• Maven - Gerenciamento de dependências
• ROME - Uasdo para gerar o Feed RSS

Como contruibuir

Por favor, leia CONTRIBUTING.md para detalhes do nosso código de conduta, e sobre como submeter um pull request para nós.

Versionamento

Nós usamos SemVer para controle de versionamento. Para as versões disponíveis, veja a tag neste repositório.

Autores

• Billie Thompson - Texto Original - PurpleBooth
• Matheus Reis - Tradução para PT-BR - ReisDev

Veja também a lista de colaboradores que fizeram parte deste projeto.

Licença

Este projeto está licenciado sob a licença MIT - consulte o arquivo LICENSE.md para obter mais detalhes.

Créditos

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