README do GitHub para imagem: crie um PNG para o próximo lançamento
Importe um README público do GitHub, resuma as alterações da versão e partilhe um cartão PNG com uma ligação para o lançamento ou para a fonte.
Ao anunciar uma versão, escolha um excerto do README que apresente o projeto e resuma as alterações. Cole o endereço do repositório no conversor de README do GitHub para imagem e exporte um PNG para a publicação, os diapositivos ou a conversa da equipa.
- Abra um repositório público e copie o endereço da página principal. Experimente octocat/Hello-World para testar a importação.
- Cole o endereço, carregue em Obter README e confirme o conteúdo no editor.
- Mantenha o nome do projeto, o número da versão e as alterações que interessam a quem lê. Edite essa cópia no conversor.
- Veja a pré-visualização à largura pretendida, escolha PNG nas opções de saída e descarregue a imagem.
Se a importação falhar, abra o repositório sem iniciar sessão e veja se o README está visível. Para uma ramificação específica ou um ficheiro local, abra a versão pretendida e cole o excerto autorizado no conversor de Markdown.
Depois de testar a importação pública, substituímos o conteúdo do editor por este exemplo original. Pode colá-lo para reproduzir o mesmo aspeto. Antes de exportar o excerto editado, confirme o autor e a data nas opções de saída.
# Trail Notes 1.2
A small command-line tool for organizing field notes.
## What's new
- Group notes by trip.
- Search by date or tag.
- Export a trip summary as Markdown.
**Quick start:** Open a notes folder, then choose a trip.
Abrir o PNG completo. O serviço de exportação do site gerou a imagem a partir da pré-visualização da ferramenta de README. A largura era de 800 px e a escala de saída era 2×.
Confirme na pré-visualização se os emblemas e as capturas de ecrã carregam. Um caminho relativo como docs/demo.png depende do repositório e da localização do ficheiro. Se falhar, use um endereço público da imagem correspondente à versão anunciada. Uma lista curta e algumas linhas de texto também podem ser suficientes.
Abra o PNG descarregado no tamanho em que será apresentado. Encurte comandos longos ou tabelas largas se dificultarem a leitura. Deixe as instruções completas no GitHub para que possam ser copiadas.
Junte à imagem uma ligação para o repositório ou para o lançamento. Se o anúncio se referir a uma versão fixa, use a página dessa versão ou a ligação permanente ao README do commit. Acrescente uma frase de texto para manter a mensagem legível se a imagem falhar. Quando estiver pronto, converta um README público numa imagem.