Skip to content

Instantly share code, notes, and snippets.

@lohhans
Forked from PurpleBooth/README-Template.md
Last active November 17, 2024 16:48
Show Gist options
  • Save lohhans/f8da0b147550df3f96914d3797e9fb89 to your computer and use it in GitHub Desktop.
Save lohhans/f8da0b147550df3f96914d3797e9fb89 to your computer and use it in GitHub Desktop.
Um modelo para fazer um bom README.md

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

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.

⌨️ com ❤️ por Armstrong Lohãns 😊

@lohhans
Copy link
Author

lohhans commented Aug 25, 2022

Cara... só tenho a agradecer!!!!

Valeu!! 💪🏻😁

@Zenhayevsky
Copy link

Obrigada!! 😁

@vitorhub
Copy link

vitorhub commented Sep 2, 2022

gostei muito do material. facilita muito a vida de dev

@JethroTiago
Copy link

Muito bom! Obrigado de verdade!

@lohhans
Copy link
Author

lohhans commented Sep 19, 2022

Obrigada!! 😁

gostei muito do material. facilita muito a vida de dev

Muito bom! Obrigado de verdade!

Sucesso, pessoal! 🚀

@CaioEmannuelDiniz
Copy link

Parabens!! Um ótimo Read.me, obrigadoo!!

@Gadelha84
Copy link

Muito obrigado! Me deu um norte excelente.

@AllGun
Copy link

AllGun commented Nov 25, 2022

Obrigado!!!

@elopes89
Copy link

elopes89 commented Dec 1, 2022

Boa 06

@lohhans
Copy link
Author

lohhans commented Dec 2, 2022

Parabens!! Um ótimo Read.me, obrigadoo!!

Muito obrigado! Me deu um norte excelente.

Obrigado!!!

Boa 06

Valeu pelo feedback galera, pra cima! 🚀👨🏻‍💻

@erica-as
Copy link

erica-as commented Dec 2, 2022

Valeu pelas dicas, cara! Vai ajudar bastante.

@henriquesnto
Copy link

Cara que material incrível!! Parabéns pela iniciativa.

@mroya
Copy link

mroya commented Jan 17, 2023

excellent bro 👍👌✔

@CarlosEduardoLemos
Copy link

Parabéns. Muito obrigado em compartilhar.

@lohhans
Copy link
Author

lohhans commented Jun 21, 2023

Valeu pelas dicas, cara! Vai ajudar bastante.

Cara que material incrível!! Parabéns pela iniciativa.

excellent bro 👍👌✔

Parabéns. Muito obrigado em compartilhar.

Valeu galera! 🚀

@IgorBVieira
Copy link

Brabo demais Irmão!

@Auggustto
Copy link

Muito obrigado man, show!!

@lohhans
Copy link
Author

lohhans commented Oct 25, 2023

Tmj pessoal! 😁

@mateusadada
Copy link

Uma grande base para poder iniciar 🚀

@victoralima79
Copy link

Muito bom!
O melhor que encontrei, muito obrigado, cara!
Clareou as ideias aqui, parabéns pela iniciativa.

@JoaoColonna
Copy link

Show de mais, modelo ficou ótimo! Valeu pela força

@lohhans
Copy link
Author

lohhans commented Feb 9, 2024

Uma grande base para poder iniciar 🚀

Muito bom! O melhor que encontrei, muito obrigado, cara! Clareou as ideias aqui, parabéns pela iniciativa.

Show de mais, modelo ficou ótimo! Valeu pela força

Sucesso gente, bora codar! 🚀

@FreitasProcopio
Copy link

Salvou muitooooo !!

@lohhans
Copy link
Author

lohhans commented Feb 20, 2024

Salvou muitooooo !!

👊🏻👊🏻

@rayantoniel
Copy link

Muito bom, vlww

@GabrielPires123
Copy link

top d+ salvou muito

@evandro-diniz
Copy link

Muito bom

@wprotheus
Copy link

Gratidão por partilhar! Excelente.

@lucasvitareli
Copy link

Muito bom, obrigado!

@MayconEspindola
Copy link

muito bom, agradeço!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment