Como fazer um README TOP 🚀🚀
Iae pessoal, como estão, tudo certo ?, recentemente venho procurando melhorar meus READ-ME e encontrei um simplemente incrivei, vou deixar uns links pra ajudar você a não só copiar mas sim aprender a fazer o seu. :)
Título do projeto Um parágrafo da descrição do projeto vai aqui
🚀 Começando Essas instruções permitirão que você obtenha uma cópia do projeto em operação na sua máquina local para fins de desenvolvimento e teste.
Consulte Implantação para saber como implantar o projeto.
📋 Pré-requisitos De que coisas você precisa para instalar o software e como instalá-lo?
Dar exemplos 🔧 Instalação Uma série de exemplos passo-a-passo que informam o que você deve executar para ter um ambiente de desenvolvimento em execução.
Diga como essa etapa será:
Dar exemplos E repita:
Até finalizar Termine com um exemplo de como obter dados do sistema ou como usá-los para uma pequena demonstração.
⚙️ Executando os testes Explicar como executar os testes automatizados para este sistema.
🔩 Analise os testes de ponta a ponta Explique que eles verificam esses testes e porquê.
Dar exemplos ⌨️ E testes de estilo de codificação Explique que eles verificam esses testes e porquê.
Dar exemplos 📦 Implantação Adicione notas adicionais sobre como implantar isso em um sistema ativo
🛠️ Construído com Mencione as ferramentas que você usou para criar seu projeto
Dropwizard - O framework web usado Maven - Gerente de Dependência ROME - Usada para gerar RSS 🖇️ Colaborando Por favor, leia o COLABORACAO.md para obter detalhes sobre o nosso código de conduta e o processo para nos enviar pedidos de solicitação.
📌 Versão Nós usamos SemVer para controle de versão. Para as versões disponíveis, observe as tags neste repositório.
✒️ Autores Mencione todos aqueles que ajudaram a levantar o projeto desde o seu início
Um desenvolvedor - Trabalho Inicial - umdesenvolvedor Fulano De Tal - Documentação - fulanodetal Você também pode ver a lista de todos os colaboradores que participaram deste projeto.
📄 Licença Este projeto está sob a licença (sua licença) - veja o arquivo LICENSE.md para detalhes.
🎁 Expressões de gratidão Conte a outras pessoas sobre este projeto 📢; Convide alguém da equipe para uma cerveja 🍺; Um agradecimento publicamente 🫂; etc.
links: https://gist.github.com/lohhans/f8da0b147550df3f96914d3797e9fb89#t%C3%ADtulo-do-projeto https://blog.rocketseat.com.br/como-fazer-um-bom-readme/