Modelos de README prontos para copiar, colar e personalizar.
Perfil do GitHub, repositórios, badges, cards de estatísticas e formatações avançadas, tudo em português.
Perfil · Repositório · Badges · Cards · Avançado · Contribuir
| Pasta | Para quê | Resultado |
|---|---|---|
perfil/ |
README do seu perfil no GitHub | Uma página de apresentação com stack, contatos e estatísticas |
repositorio/ |
README dos seus projetos | Descrição, instalação, uso, contribuição e licença |
badges-shields/ |
Selos de tecnologias, redes sociais e ferramentas | Badges prontos, com a URL para copiar |
cards-status/ |
Estatísticas do seu GitHub | Cards com temas para escolher |
avancado/ |
Recursos do Markdown do GitHub | Alertas, seções recolhidas, diagramas e mapas |
- Escolha um modelo e abra o arquivo
.md. - Copie o conteúdo e cole no seu
README.md. - Troque
{seu nome},SEU-USUARIOeiuricodepelos seus dados.
Tip
Para o README de perfil, crie um repositório público com o mesmo nome do seu usuário do GitHub e coloque o README.md nele. O GitHub mostra esse arquivo no topo do seu perfil.
| Modelo | Estilo |
|---|---|
| Exemplo 01 | Apresentação com ilustração e badges de contato |
| Exemplo 02 | Apresentação escrita como código JavaScript |
| Exemplo 03 | Texto de apresentação ao lado do card de estatísticas |
| Exemplo 04 | Experiência profissional com logos e tecnologias |
| Exemplo 05 | Skills com ícones e estatísticas do GitHub |
| Exemplo 06 | Sobre mim, skills em badges, estatísticas e contato |
| Exemplo 07 | Painel completo: estatísticas, linguagens, sequência e visitantes |
O Exemplo 01 é um README completo para projetos: badges, descrição, lista de tarefas, pré-requisitos, instalação, uso, como contribuir, colaboradores e licença.
readme-template/
├── perfil/ # modelos de README de perfil
├── repositorio/ # modelo de README de projeto
├── badges-shields/ # catálogo de badges
├── cards-status/ # cards de estatísticas e temas
├── avancado/ # alertas, diagramas, mapas e mais
├── CONTRIBUTING.md # como contribuir
└── LICENSE.md # licença MIT
Contribuições são bem-vindas, seja um modelo novo, um badge que falta ou um link quebrado. Leia o guia de contribuição para ver como enviar o seu pull request.
Distribuído sob a licença MIT. Veja LICENSE.md para mais detalhes.
Este projeto foi construído a partir de ideias e ferramentas de outros projetos:
O conteúdo de avancado/ é adaptado da documentação do GitHub, disponível sob a licença CC BY 4.0.