Publicamos atualizações frequentes em nossa documentação, e a tradução desta página ainda pode estar em andamento. Para obter as informações mais recentes, acesse a documentação em inglês. Se houver problemas com a tradução desta página, entre em contato conosco.

Sobre LEIAMEs

Você pode adicionar um arquivo LEIAME ao seu repositório para informar outras pessoas por que seu projeto é útil, o que elas podem fazer com o projeto e como elas podem usá-lo.

Neste artigo

Esse documento ajudou você?

Ajude-nos a tornar esses documentos ótimos!

Todos os documentos do GitHub são de código aberto. Você percebeu que algo que está errado ou não está claro? Envie um pull request.

Faça uma contribuição

Ou, aprenda como contribuir.

Um arquivo LEIAME, junto com a licença de repositório, diretrizes de contribuição e um código de conduta ajudam você a comunicar as expectativas e gerenciar contribuições para o seu projeto.

Um LEIAME, muitas vezes, é o primeiro item que um visitante verá ao visitar seu repositório. Os arquivos LEIAME geralmente 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

Se você colocar o arquivo LEIAME na raiz do repositório, docs, ou no diretório .github oculto, o GitHub reconhecerá e apresentará automaticamente o LEIAME aos visitantes do repositório.

Página principal do repositório github/scientist e seu arquivo LEIAME

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

Arquivo LEIAME no nome de usuário/repositório do nome de usuário

Muitos projetos usam uma tabela de conteúdo no início de um LEIAME para direcionar usuários para diferentes seções do arquivo. Você pode vincular diretamente a uma seção de um arquivo interpretado, passando o mouse sobre o título da seção para expor o link:

Link da seção no arquivo LEIAME para o repositório github/scientist

É possível definir links relativos e caminhos de imagens em seus arquivos representados para ajudar os leitores a acessar outros arquivos no repositório.

Um link relativo é um link que é relativo ao arquivo atual. Por exemplo, se você tiver um arquivo LEIAME na raiz do seu repositório e tiver outro arquivo em docs/CONTRIBUTING.md, o link relativo para CONTRIBUTING.md no seu README pode se parecer com isso:

[Diretrizes de contribuição para este projeto](docs/CONTRIBUTING.md)

GitHub transformará automaticamente o seu link relativo ou caminho da imagem baseado em qualquer branch em que você estiver no momento para que o link ou caminho sempre funcione. Você pode usar todas as operações de links relativos, como ./ e ../.

Os links relativos são mais fáceis para usuários que clonam o seu repositório. Os links absolutos podem não funcionar em clones do seu repositório - recomendamos usar links relativos para referir-se a outros arquivos no seu repositório.

Leia mais

Esse documento ajudou você?

Ajude-nos a tornar esses documentos ótimos!

Todos os documentos do GitHub são de código aberto. Você percebeu que algo que está errado ou não está claro? Envie um pull request.

Faça uma contribuição

Ou, aprenda como contribuir.