Um arquivo README, com uma licença de repositório e diretrizes de contribuição, ajuda você a comunicar expectativas e a gerenciar contribuições para 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 Enterprise reconhecerá e apresentará automaticamente o LEIAME aos visitantes do repositório.
If you add a README file to the root of a public repository with the same name as your username, that README will automatically appear on your profile page. You can edit your profile README with GitHub Flavored Markdown to create a personalized section on your profile.
Links de seção nos arquivos LEIAME e páginas blob
Muitos projetos usam uma tabela de conteúdo no início de um LEIAME para direcionar usuários para diferentes seções do arquivo. You can link directly to a section in a rendered file by hovering over the section heading to expose the link:
Links relativos e caminhos de imagem em arquivos LEIAME
You can define relative links and image paths in your rendered files to help readers navigate to other files in your repository.
A relative link is a link that is relative to the current file. For example, if you have a README file in root of your repository, and you have another file in docs/CONTRIBUTING.md, the relative link to CONTRIBUTING.md in your README might look like this:
[Contribution guidelines for this project](docs/CONTRIBUTING.md)
GitHub Enterprise will automatically transform your relative link or image path based on whatever branch you're currently on, so that the link or path always works. You can use all relative link operands, such as ./ and ../.
Relative links are easier for users who clone your repository. Absolute links may not work in clones of your repository - we recommend using relative links to refer to other files within your repository.