Criar um README para uma organização

É possível criar um LEIAME para informar aos seus membros o que está acontecendo em sua empresa.

Quem pode usar esse recurso?

Enterprise owners can create and edit an enterprise README.

Neste artigo

Sobre READMEs para empresas

Para ajudar as pessoas a entender o que está acontecendo em sua empresa, você deve criar um LEIAME. Por exemplo, é possível usar um LEIAME para ajudar os membros a aprender sobre diferentes organizações na empresa, para compartilhar links para recursos importantes ou para comunicar informações sobre as configurações e políticas da sua empresa.

O README é exibido na página “Visão geral” da empresa, que é a página inicial que você vê quando acessa a página da empresa. Essa página só é visível para membros da empresa.

Também é possível criar arquivos README para organizações em sua empresa, visíveis publicamente ou apenas para membros. Para saber mais, confira Personalizando o perfil da sua organização.

Criar um README para uma organização

  1. Navegue até sua empresa. Por exemplo, na página Enterprises em GitHub.com.

  2. Na página de "Visão geral", clique em Criar LEIAME. Se um LEIAME já estiver presente na página, clique em Editar.

  3. Escreva o conteúdo do seu README. É possível usar Markdown para formatar o conteúdo, como adicionar títulos, imagens e listas. Para saber mais, confira Sintaxe básica de escrita e formatação.

    Observação

    Você só pode adicionar link a imagens hospedadas publicamente em seu README. Não é possível fazer o upload de uma imagem para o LEIAME ou vincular a uma imagem de um repositório privado.

  4. Clique em Salvar.

Leitura adicional

  •         [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes)

  •         [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme)