Nome do Projeto é um(a) <utilitário/ferramenta/recurso>
que permite <público_alvo>
fazer <ação/tarefa>
.
Linha de informações adicionais sobre o que o projeto faz. Sua introdução deve ter cerca de 2 ou 3 frases. Não exagere, as pessoas não vão ler
Antes de começar, verifique se você atendeu aos seguintes requisitos:
- Você instalou a versão mais recente do
<idioma da codificação / dependência / requisito_1>
- Você tem uma máquina
<Windows / Linux / Mac>
. Declare qual SO é suportado / o que não é. - Você leu
<guide / link / documentation_related_to_project>
.
Para instalar o <nome_projeto>, siga estes passos:
Linux e macOS:
<comando>
Windows:
<comando>
Para usar o <nome_projeto>, siga estes passos:
<exemplos_de_uso>
Adicione comandos de execução e exemplos que você acha que os usuários acharão úteis. Forneça uma referência de opções para pontos de bônus!
Faça um TODO List, se necessário, das próximas etapas ou do que ficou faltando nesta etapa do projeto.
As próximas ações para o <nome_projeto> são:
-
Escrever README - Escrever Testes
Para contribuir com <nome_projeto>, siga estes passos:
- Fork esse repositório.
- Crie uma branch:
git checkout -b <branch_name>
. - Faça suas mudanças e comite para:
git commit -m '<commit_message>'
- Push para a branch de origem:
git push origin <nome_projeto>/<location>
- crie um pull request.
Como alternativa, consulte a documentação do GitHub em criando uma pull request.
Agradeço às seguintes pessoas que contribuíram para este projeto:
Você pode considerar o uso de algo como a especificação como Todos os colaboradores e sua [chave emoji] (https://allcontributors.org/docs/pt/ tecla emoji).
Se você quiser entrar em contato comigo, entre em contato com [email protected].
Este projeto usa a seguinte licença: [<license_name>] ().