Pular para o conteúdo
Início » Github » Criando o README do seu perfil no Github

Criando o README do seu perfil no Github

Personalize o README do seu perfil no Github, deixe seu cartão de visitas de programador com a “sua cara” e aumente a visibilidade e clareza de sua posição técnica na área de desenvolvimento de software.

O que é README

Um arquivo README (LEIAME em Português), muitas vezes, é o primeiro item que um visitante verá ao acessar seu repositório. Geralmente eles incluem informações sobre:

  • O que o projeto faz
  • Por que o projeto é útil
  • Como os usuários podem começar a usar o projeto
  • Onde os usuários podem obter ajuda com seu projeto
  • Quem mantém e contribui com o projeto

Sistemas de gerenciamento de projetos de software como Github, Gitlab ou Bitbucket, os arquivos README são escritos em Markdown. No Github é utilizada uma versão chamada GitHub Flavored Markdown.

No caso de seu perfil Github, o README permitirá a personalização como um cartão de visitas profissional.

O que é um Perfil no Github

Sua página de perfil conta sua história profissional, como pessoa desenvolvedora de software, por meio de repositórios nos quais você está interessado(a), das contribuições que fez e das interações que teve.

Você pode adicionar informações pessoais sobre si mesmo na bio, como locais em que trabalhou anteriormente, os projetos com os quais contribuiu ou interesses que você tem que outras pessoas talvez gostem de saber.

Se você adicionar um arquivo arquivo README à raiz de um repositório público com o mesmo nome de usuário, esse README aparecerá automaticamente na sua página de perfil, podendo editar para criar uma seção personalizada no seu perfil.

Arquivo README do perfil exibido no perfil

Personalizando o README do seu perfil Github

Você pode adicionar um README ao seu perfil do GitHub para personalizar como as outras pessoas conhecem você profissionalmente.

Quem decide quais informações incluir no README do seu perfil é você. Com total controle sobre a forma como se apresenta no GitHub.

Aqui estão alguns exemplos de informações que podem ser interessantes, divertidas ou úteis no README do seu perfil.

  • Uma seção “Sobre mim” que descreve seu trabalho e seus interesses
  • Contribuições de projetos das quais você está orgulhoso, bem como contexto dessas contribuições
  • Orientação para obter ajuda nas comunidades onde você está envolvido
  • Curiosidades pessoais

Você pode formatar texto e incluir emojis, imagens e GIFs no seu perfil README usando o markdown específico do GitHub.

Configuração inicial do README de seu perfil

Pré-requisitos para que o Github mostre o README do seu perfil:

  • Criar um repositório com um nome correspondente ao seu nome de usuário no Github
  • Configurar este repositório como público
  • Adicionar um arquivo chamado README.md na raiz do repositório
  • Adicionar o conteúdo desejado no arquivo README

No meu caso, meu username é nunomazer, portanto na tela de criação de um novo repositório, as configurações ficam como na imagem a seguir, com as opções Public e Add a README file marcadas:

Crar novo repositório no Github

Ao mostrar seu novo repositório, um botão para edição do README é habilitado, para que você comece a personalizar seu perfil profissional.

Editar README no perfil Github

Ao clicar no botão de edição, um arquivo com tópicos sugeridos é aberto, onde você pode complementar de acordo com sua história profissional e interesses a serem divulgados:

README com sugestões

Você pode retirar os comentários ( <!-- e --> ) e iniciar a personalização de seu perfil por meio do README no Github.

Parabéns, você acaba de personalizar seu perfil no Github, a seguir um exemplo de como fica profissional, mesmo com o conteúdo mais simples e sugerido ao criar sua personalização.

Agora é só usar a imaginação !!!

Perfil simples Github

Deixe um comentário

O seu endereço de e-mail não será publicado.

pt_BRPortuguese
%d blogueiros gostam disto: