image

Unlimited bootcamps + English course forever

80
%OFF
Article image
Gabriel Felipe
Gabriel Felipe23/04/2025 21:43
Share

Como ter um bom README!✅

  • #GitHub

Você dedicou horas, dias, semanas codando um projeto, colocou no GitHub, mas quando alguém vai ver, não consegue entender o que faz, o que é, como rodar, quais tecnologias usou... é aí que entra o poder de um bom arquivo README .md, como um "cartão de visitas". 

O que é essencial em um bom README?

✅ Um título claro (nome do projeto). 

✅ Imagem do projeto, se possível. 

📑 Descrição breve (o que é?).

🎯 Funcionalidades (o que faz?). 

💻 Tecnologias utilizadas (lista). 

🛠️ Como instalar e rodar o projeto (passo a passo), caso seja necessário. 

🌐 Site/Link do deploy.

👨‍💻 Além disso, pode colocar seções como Colaboradores; Etapas realizadas; Status; Licenças, conforme sua necessidade. 

Criar um README, utilizando Markdown, é fácil, valoriza o seu trabalho e apresenta o que você fez, permitindo entender o projeto rapidamente, demonstrando profissionalismo, organização e facilitando a avaliação do seu trabalho.

E você, tem utilizado README para apresentar seus projetos no Github? 

Caso queira exemplos de README simples e objetivo, acesse meu Github https://github.com/Gabolonhez e veja meus repositórios. 

Share
Recommended for you
Microsoft 50 Anos - GitHub Copilot
Microsoft AI for Tech - GitHub Copilot
Microsoft 50 Anos - Prompts Inteligentes
Comments (0)