Personalizando o README do seu perfil do GitHub
Tags: beginners, github, braziliandevs, writing
Published: 2024-05-13 16:45:32

Opa, tranquilo? Bora deixar o README do teu GitHub bonitão!

Antes de começar realmente, se você não sabe o que é README nem markdown eu recomendo fortemente que veja os outros artigos dessa série.

O README do GitHub é o cartão de visita do seu perfil. Antes de personalizar ele, você precisa criar ele.

## Criando README

Crie um repositório com o mesmo nome do seu perfil. Como meu nome de usuário é "kauefraga" o nome do repositório seria "kauefraga" também.

![criando repositório seu-nome-de-usuario/seu-nome-de-usuario](https://raw.githubusercontent.com/kauefraga/blog/main/content/posts/personalizando-o-readme-do-seu-perfil-do-github/images/guide-1.png)

Para facilitar seu trabalho já inclua o arquivo README no seu repositório.

![incluindo o arquivo README e criando o repositório de fato](https://raw.githubusercontent.com/kauefraga/blog/main/content/posts/personalizando-o-readme-do-seu-perfil-do-github/images/guide-2.png)

Feito isso você está pronto para customizar o seu README.

Eu recomendo que você coloque as seguintes informações:

- O que você gosta de fazer
- Planos para o ano atual
- Projetos
- As tecnologias (tech stack) e ferramentas que você usa
- Contato

Vale ressaltar que o README deve ficar com a sua cara, com o que você gostar e achar que deve ter. Reflita sua extravagância, seu minimalismo, suas cores favoritas, tudo que te represente.

Para editar pelo próprio GitHub clique no lápis para editar, veja a seguir.

![entrando no modo de edição do README](https://raw.githubusercontent.com/kauefraga/blog/main/content/posts/personalizando-o-readme-do-seu-perfil-do-github/images/guide-3.png)

A partir de agora é contigo, totalmente pessoal. Vou deixar vários materiais e inspirações de estilos e layouts.

Uma coisa que eu gostaria de ressaltar, eu gosto de ter um README bonitinho e algumas pessoas (recrutadores, outros desenvolvedores, etc.) olham sim, porém não leve tão a sério. Faça porque você quer falar um pouco sobre quem você é e expor informações técnicas suas.

### GitHub Readme Stats

Com esses cards você pode mostrar informações relevantes do seu perfil do GitHub e personalizar as cores.

Veja o [repositório](https://github.com/anuraghazra/github-readme-stats) ou vá direto para a [seção dos cards](https://github.com/anuraghazra/github-readme-stats?tab=readme-ov-file#github-stats-card).

![demo dos stats](https://raw.githubusercontent.com/kauefraga/blog/main/content/posts/personalizando-o-readme-do-seu-perfil-do-github/images/github-stats.png)

### Skill Icons

Quer expor as tecnologias que você usa, está estudando ou querendo estudar? Tá na mão!

Veja o [site](https://skillicons.dev/) ou vá direto na [documentação](https://github.com/tandpfun/skill-icons#specifying-icons).

![demo dos skill icons](https://raw.githubusercontent.com/kauefraga/blog/main/content/posts/personalizando-o-readme-do-seu-perfil-do-github/images/skill-icons.png)

> Se você não viu ainda, na seção [sobre mim](https://kauefraga.github.io/blog/about/#sobre-mim) do blog eu uso os _skill icons_.

### Markdown Badges

Veja o [repositório markdown badges](https://github.com/Ileriayo/markdown-badges) e o [badges for readme.md profile](https://github.com/alexandresanlim/Badges4-README.md-Profile).

![demo das badges](https://raw.githubusercontent.com/kauefraga/blog/main/content/posts/personalizando-o-readme-do-seu-perfil-do-github/images/badges.png)

### Snake Game

Você deve conhecer o jogo da cobrinha, certo? Imagina uma cobrinha comendo suas contribuições no seu gráfico de contribuições.

Veja o [repositório](https://github.com/Platane/snk) e um [tutorial de como adicionar no seu perfil](https://dev.to/henriquelopes42/como-adicionar-o-snake-game-jogo-da-cobrinha-no-seu-perfil-do-github-40m2).

![demo da cobrinha comendo os commits](https://raw.githubusercontent.com/kauefraga/blog/main/content/posts/personalizando-o-readme-do-seu-perfil-do-github/images/snake-game.png)

### Wakatime

Quer exibir métricas do seu tempo em _x_ projeto ou usando _y_ linguagem de programação? Comece a usar o [wakatime](https://wakatime.com/) e veja esse artigo também, ["Exibindo no Github métricas de tempo gasto em linguagens usando Wakatime"](https://airton.dev/article/exibindo-no-github-metricas-de-tempo-gasto-em-linguagens-usando-wakatime/).

![demo do wakatime direto do artigo do Airton Zanon](https://raw.githubusercontent.com/kauefraga/blog/main/content/posts/personalizando-o-readme-do-seu-perfil-do-github/images/wakatime.png)

## Inspirações

Não tem nada melhor que ter opções para se inspirar, né? Aqui vão alguns READMEs que eu considero legais. Clique na imagem para ir até o README.

Começando com o meu 😂

[![meu readme](https://raw.githubusercontent.com/kauefraga/blog/main/content/posts/personalizando-o-readme-do-seu-perfil-do-github/images/meu-readme.png)](https://github.com/kauefraga/kauefraga)

Sem frufru? Olha esse do Filipe

[![readme do datsfilipe](https://raw.githubusercontent.com/kauefraga/blog/main/content/posts/personalizando-o-readme-do-seu-perfil-do-github/images/readme-datsfilipe.png)](https://github.com/datsfilipe/datsfilipe)

Simples mas nem tanto? O Lucas amassou aqui

[![readme do lucasmorais1998](https://raw.githubusercontent.com/kauefraga/blog/main/content/posts/personalizando-o-readme-do-seu-perfil-do-github/images/readme-lucasmorais1998.png)](https://github.com/LucasMorais1998/LucasMorais1998)

Nessa mesma ideia, a Tifany arrasou também

[![readme da pinuya](https://raw.githubusercontent.com/kauefraga/blog/main/content/posts/personalizando-o-readme-do-seu-perfil-do-github/images/readme-pinuya.png)](https://github.com/pinuya/pinuya)

Continuando...

[![readme do hiroshimorowaka](https://raw.githubusercontent.com/kauefraga/blog/main/content/posts/personalizando-o-readme-do-seu-perfil-do-github/images/readme-hiroshimorowaka.png)](https://github.com/hiroshimorowaka/hiroshimorowaka)

[![readme da cherryramatisdev](https://raw.githubusercontent.com/kauefraga/blog/main/content/posts/personalizando-o-readme-do-seu-perfil-do-github/images/readme-cherryramatisdev.png)](https://github.com/cherryramatisdev/cherryramatisdev)

[![readme da jumayumic](https://raw.githubusercontent.com/kauefraga/blog/main/content/posts/personalizando-o-readme-do-seu-perfil-do-github/images/readme-jumayumic.png)](https://github.com/JuMayumiC/JuMayumiC)

[![readme do cr-0w](https://raw.githubusercontent.com/kauefraga/blog/main/content/posts/personalizando-o-readme-do-seu-perfil-do-github/images/readme-cr-0w.png)](https://github.com/cr-0w/cr-0w)

[![readme do joevtap](https://raw.githubusercontent.com/kauefraga/blog/main/content/posts/personalizando-o-readme-do-seu-perfil-do-github/images/readme-joevtap.png)](https://github.com/joevtap/joevtap)

[![readme do erickcestari](https://raw.githubusercontent.com/kauefraga/blog/main/content/posts/personalizando-o-readme-do-seu-perfil-do-github/images/readme-erickcestari.png)](https://github.com/erickcestari/erickcestari)

[![readme da nftsz](https://raw.githubusercontent.com/kauefraga/blog/main/content/posts/personalizando-o-readme-do-seu-perfil-do-github/images/readme-nftsz.png)](https://github.com/NFTSZ/NFTSZ)

## Recomendações

- [Como personalizar o seu perfil no GitHub (Readme) da Rafaella Ballerini](https://youtu.be/TsaLQAetPLU)
- [Guia resumido da Laura Kibum](https://twitter.com/kibumLaura/status/1754254161615491117)

Estarei aberto para dúvidas ou sugestões por aqui ou pelo [Twitter/X](https://twitter.com/rkauefraga).

Muito obrigado por ter lido até aqui ❤.