A collection of my useful code snippets
And this file is a snippet too (I never remember how to write a good readme.md file).
The code below was copied from this repo: https://github.com/iuricode/readme-template/blob/main/repositorio/exemplo-01.md
Linha adicional de texto informativo sobre o que o projeto faz. Sua introdução deve ter cerca de 2 ou 3 linhas. Não exagere, as pessoas não vão ler.
O projeto ainda está em desenvolvimento e as próximas atualizações serão voltadas nas seguintes tarefas:
- Tarefa 1
- Tarefa 2
- Tarefa 3
- Tarefa 4
- Tarefa 5
Antes de começar, verifique se você atendeu aos seguintes requisitos:
- Você instalou a versão mais recente de
<linguagem / dependência / requeridos>
- Você tem uma máquina
<Windows / Linux / Mac>
. Indique qual sistema operacional é compatível / não compatível. - Você leu
<guia / link / documentação_relacionada_ao_projeto>
.
Para instalar o <nome_do_projeto>, siga estas etapas:
Linux e macOS:
<comando_de_instalação>
Windows:
<comando_de_instalação>
Para usar <nome_do_projeto>, siga estas etapas:
<exemplo_de_uso>
Adicione comandos de execução e exemplos que você acha que os usuários acharão úteis. Fornece uma referência de opções para pontos de bônus!
Para contribuir com <nome_do_projeto>, siga estas etapas:
- Bifurque este repositório.
- Crie um branch:
git checkout -b <nome_branch>
. - Faça suas alterações e confirme-as:
git commit -m '<mensagem_commit>'
- Envie para o branch original:
git push origin <nome_do_projeto> / <local>
- Crie a solicitação de pull.
Como alternativa, consulte a documentação do GitHub em como criar uma solicitação pull.
Agradecemos às seguintes pessoas que contribuíram para este projeto:
Iuri Silva |
Mark Zuckerberg |
Steve Jobs |
Quer fazer parte desse projeto? Clique AQUI e leia como contribuir.
Esse projeto está sob licença. Veja o arquivo LICENÇA para mais detalhes.