DEV Community

Cover image for Um README para o seu user do Github?
Leo Yassuda
Leo Yassuda

Posted on

2 1

Um README para o seu user do Github?

Dê um upgrade para o seu perfil =]

Em poucos passos podemos modificar a página do nosso perfil e acrescentar uma cara mais bacaninha como se fosse um "about me". 🖖

Alt Text

Bora lá e sem enrolação!

Passo a passo:

  • Qualquer editor de texto (se tiver suporte para tipografia Markdown é bem vindo).
  • Um repo com o mesmo nome de seu USERNAME do Github.

    • no meu caso, eu já tenho como podem ver na imagem 😛

    Alt Text

  • Esse repo tem de ser PÚBLICO.

    Alt Text

  • Na raiz do repo criar o arquivo README.md ou na própria página de criação de repo deixar clicado a opção de criar o arquivo junto do repo.

Alt Text

  • Pronto! Agora basta customizar o README.md como quiser! 🙌

Se quiser pode usar o meu de exemplo [readme-exemplo] 👈

Dica:

  • Caso não apareça o README renderizado no seu perfil, vá no repo e clique no botão "Share to Profile"

Alt Text

Hostinger image

Get n8n VPS hosting 3x cheaper than a cloud solution

Get fast, easy, secure n8n VPS hosting from $4.99/mo at Hostinger. Automate any workflow using a pre-installed n8n application and no-code customization.

Start now

Top comments (0)

Qodo Takeover

Introducing Qodo Gen 1.0: Transform Your Workflow with Agentic AI

Rather than just generating snippets, our agents understand your entire project context, can make decisions, use tools, and carry out tasks autonomously.

Read full post