Padrão de README para completa documentação em português

README.md

Título do projeto

Um parágrafo do projeto vai aqui

Começando

Estas instruções vão criar uma cópia do projeto na sua máquina local com a finalidade de desenvolver ou testar. Veja o deployment para entender como ou como fazer o deploy do mesmo em sistema em live.

Pré-requisitos

Quais são os requisitos para instalar.

Dê exemplos

Instalação

Série de passos e exemplos que vão ensinar como deixar o ambiente de desenvolvimento rodando.

Dizer qual são estes passos aqui

Dê exemplos

E repita

até o último passo

Termine o passos acima com um exemplo rodando (gif)

Rode os teste

Explique como executar testes automatizados no sistema.

Finalize e explique como finalizar

Explique os teste e o porquê dos mesmos

Dê um exemplo

Deployment

Escreva instruções adicionais de como fazer o deploy em um sistema live.

Construido com

• Link 1 - Descrição de algum framework
• Link 2 - Denpendência
• Link 3 - Gerador de alguma coisa

Contribuição

Por favor leia CONTRIBUTING.md para detalhes de como contribuir conosco.

Versionamento

Usamos vers para o versionamento. Para ver as versões disponíveis tags dentro do repositório.

Autores

• Nome Sobrenome - Iniciativa - githubusername

Veja também contribuidores que participaram e contribuíram para o projeto.

Licença

Este projeto é licenciado pela MIT License - veja em LICENSE.md para detalhes

Saiba mais

• Fale para todos o porquê do projeto ser criado
• Inspiração
• etc