Executando verificação de segurança...
18

Personalizando o README do seu perfil do GitHub

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.

  1. Introdução ao markdown e aos READMEs
  2. Personalizando o README do seu projeto

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

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

incluindo o arquivo README e criando o repositório de fato

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

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 ou vá direto para a seção dos cards.

demo dos stats

Skill Icons

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

Veja o site ou vá direto na documentação.

demo dos skill icons

Se você não viu ainda, na seção sobre mim do blog eu uso os skill icons.

Markdown Badges

Veja o repositório markdown badges e o badges for readme.md profile.

demo das badges

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 e um tutorial de como adicionar no seu perfil.

demo da cobrinha comendo os commits

Wakatime

Quer exibir métricas do seu tempo em x projeto ou usando y linguagem de programação? Comece a usar o wakatime e veja esse artigo também, "Exibindo no Github métricas de tempo gasto em linguagens usando Wakatime".

demo do wakatime direto do artigo do Airton Zanon

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

Sem frufru? Olha esse do Filipe

readme do datsfilipe

Simples mas nem tanto? O Lucas amassou aqui

readme do lucasmorais1998

Nessa mesma ideia, a Tifany arrasou também

readme da pinuya

Continuando...

readme do hiroshimorowaka

readme da cherryramatisdev

readme da jumayumic

readme do cr-0w

readme do joevtap

readme do erickcestari

readme da nftsz

Recomendações

Estarei aberto para dúvidas ou sugestões por aqui ou pelo Twitter/X.

Muito obrigado por ter lido até aqui ❤.

1

Uma beleza.
Imagina chegar em um projeto e o README tá vazio?!
Gosto muito de laravel e a maioria do projetos deixa o README original do laravel, que nada diiz sobre o projeto.
Importante documentar o projeto no READMR e quando o projeto for importane criar uma pasta docs com um site de documentação (sugestão: mkdocs).
Outro detalhe importaante, quando for o caso, fornecer um script sql paara ovisitante testar o projeto com facilidade.
Muito grato.

1

Primeiramente, parabéns pelo post mano, bem legal as dicas.

Segundamente, eu acredito que é bom ressaltar a importância da originalidade e da personalidade do seu README, até porque como diz no post, "O README do GitHub é o cartão de visita do seu perfil", e eu concordo plenamente.

Eu vejo muita gente, literalmente copiando e colando o README de outra pessoa na caruda sem nem pensar um pouco sobre isso. Claro, não é um crime você se inspirar em outros perfis interessantes, mas acho que uma cópia sem mais nem menos acaba prejudicando e não ajudando.

Você não precisa fazer o README todo do zero, mas coisas que transpareçam quem você é e/ou aspectos da sua vida são uma adição muito valorosa no meu ponto de vista. Me usando como exemplo, eu coloquei o spotify-github-profile no meu perfil:

print do spotify-github-profile

Por mais que seja uma coisa simples, transparece como a música faz parte de quem eu sou a ponto de eu exibir no meu perfil.

1
0
0