Sobre o README do seu perfil
Você pode compartilhar informações sobre si mesmo com a comunidade em GitHub criando um README sobre o seu 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
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, consulte "Começando a escrever e formatar no GitHub".
Pré-requisitos
O GitHub irá exibir o README 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.
Observação: Se você criou um repositório público com o mesmo nome do seu nome de usuário antes de julho de 2020, GitHub não mostrará automaticamente o README do repositório no seu perfil. Você pode compartilhar manualmente o README do repositório no seu perfil, acessando o repositório no GitHub.com e clicando em Compartilhar com o perfil.
Adicionar um README do perfil
-
No canto superior direito de qualquer página, use o menu suspenso e selecione Novo repositório.
-
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".
-
Se desejar, adicione uma descrição do repositório. Por exemplo, "Meu repositório pessoal".
-
Selecione Público.
-
Selecione Initialize this repository with a README (Inicializar este repositório com um README).
-
Clique Criar repositório.
-
Acima da barra lateral direita, clique em Editar README.
O arquivo README gerado é pré-preenchido com um modelo para dar alguma inspiração para o README do seu perfil.
Para obter um resumo todos os emojis disponíveis e seus códigos, consulte "Folha de dicas de Emoji".
Remover um README do perfil
O perfil README é removido do seu perfil de GitHub se algum dos pontos seguintes se aplicar:
- O arquivo README está vazio ou não existe.
- O repositório é privado.
- O nome do repositório não corresponde mais ao seu nome de usuário.
The method you choose is dependant upon your needs, but if you're unsure, we recommend making your repository private. Para obter informações sobre as etapas etapas de como tornar seu repositório privado, consulte "Alterar a visibilidade de um repositório".