Gerenciar o README do seu perfil

Você pode adicionar um README ao seu perfil deGitHub para contar a outras pessoas sobre você.

Quem pode usar esse recurso?

Profile READMEs are not available to contas de usuário gerenciadas.

Neste artigo

Sobre o README do seu perfil

Você pode compartilhar informações sobre si mesmo com a comunidade em GitHub criando um LEIAME do perfil. GitHub mostra o README do seu perfil na parte superior da sua página de perfil.

Você decide quais informações incluir no README do seu perfil. Portanto, você tem total controle sobre a forma como se apresenta no GitHub. Aqui estão alguns exemplos de informações que os visitantes podem achar interessantes, divertidas ou úteis no README do seu perfil.

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

Captura de tela da página de perfil para @octocato. No canto superior direito, um LEIAME de perfil cumprimenta o visualizador e lista informações sobre o trabalho do usuário.

Você pode formatar texto e incluir emoji, imagens e GIFs no seu perfil README usando o markdown específico do GitHub. Para obter mais informações, confira "Introdução à escrita e formatação no GitHub". Para obter um guia prático para personalizar o README do seu perfil, confira "Guia de início rápido de gravação no GitHub".

Pré-requisitos

O GitHub exibirá o LEIAME do seu perfil na sua página de perfil se todas as informações a seguir forem verdadeiras.

  • Você criou um repositório com um nome que corresponde ao nome de usuário do GitHub.
  • O repositório é público.
  • O repositório contém um arquivo denominado README.md na sua raiz.
  • O arquivo README.md contém qualquer conteúdo.

Note

Se você criou um repositório público com o mesmo nome do nome de usuário antes de julho de 2020, o GitHub não mostra automaticamente o README do repositório no seu perfil. Você pode compartilhar manualmente o LEIAME do repositório para o seu perfil acessando o repositório no GitHub e clicando em Compartilhar no perfil.

Adicionar um README do perfil

  1. No canto superior direito de qualquer página, selecione e clique em Novo repositório.

    Captura de tela de um menu suspenso GitHub mostrando as opções para criar novos itens. Há um item de menu "Novo repositório" com o contorno em laranja escuro.

  2. Em "Nome do repositório", digite um nome de repositório que corresponde ao nome de usuário do GitHub. Por exemplo, se seu nome de usuário for "octocat", o nome do repositório deverá ser "octocat".

  3. Opcionalmente, no campo "Descrição", digite uma descrição do seu repositório. Por exemplo, "Meu repositório pessoal".

  4. Selecione Público.

  5. Selecione Inicializar este repositório com um LEIAME.

  6. Clique em Criar repositório.

  7. Acima da barra lateral direita, clique em Editar LEIAME.

O arquivo README gerado é pré-preenchido com um modelo para dar alguma inspiração para o README do seu perfil.

Para ver um resumo de todos os emojis disponíveis e os respectivos códigos, confira "Folha de referências de emojis".

Remover um README do perfil

O perfil README será removido do seu perfil de GitHub se algum dos pontos seguintes se aplicar:

  • O arquivo LEIAME é removido ou esvaziado.
  • O repositório passou a ser privado.
  • O nome do repositório não corresponde mais ao seu nome de usuário devido a uma alteração em um ou ambos os nomes.

The method you choose is dependant upon your needs, but if you're unsure, we recommend making your repository private. Para ver as etapas de como tornar seu repositório privado, confira "Definir a visibilidade do repositório".

Leitura adicional