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.
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>
Esse projeto está sob licença. Veja o arquivo LICENÇA para mais detalhes.