Formed in 2009, the Archive Team (not to be confused with the archive.org Archive-It Team) is a rogue archivist collective dedicated to saving copies of rapidly dying or deleted websites for the sake of history and digital heritage. The group is 100% composed of volunteers and interested parties, and has expanded into a large amount of related projects for saving online and digital history.
Um arquivo LEIAME, junto com uma licença de repositório e diretrizes de contribuição 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 Enterprise reconhecerá e apresentará automaticamente o LEIAME aos visitantes do repositório.
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. 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:
Links relativos e caminhos de imagem em arquivos LEIAME
É 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 Enterprise 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.