GitHub README

Arte ASCII para README do GitHub

Crie um título para seu projeto ou um divisor de seção e copie o bloco Markdown completo. Sem cadastro ou instalação.

Montar seu README

Use o banner acima, adicione os detalhes e baixe um arquivo Markdown.

Comece com um exemplo completo

Escolha um projeto Python simples, uma biblioteca ou uma ferramenta de terminal. Adapte os textos e comandos ao seu projeto; seu banner atual será mantido.

Projeto simples

Uma apresentação curta, um comando funcional e notas para contribuir.

Biblioteca Python

Um pequeno módulo reutilizável com um exemplo de importação.

Ferramenta de terminal

Um comando de terminal com arquivo de entrada e resultado esperado.

Baixar os exemplos funcionais (ZIP, em inglês)

Prévia do README

Prévia do README
Markdown completo

Estes campos ficam na página e não entram no link do banner. Instalação e uso são copiados como código; descrição e contribuições como texto simples.

Como colocar o banner no README

  1. Digite o nome do projeto e escolha uma fonte. Small e Mini ajudam a manter títulos compactos.
  2. Confira a largura. A meta de 80 colunas é um ponto de partida; teste algo menor para leitores no celular.
  3. Clique em “Copiar Markdown” e cole no README. O bloco de código já acompanha o desenho.
  4. Mantenha um título Markdown comum junto da arte, para que o nome do projeto continue acessível.

Por que usar um bloco de código?

Espaços e quebras de linha formam o desenho. Um bloco delimitado por crases preserva a fonte monoespaçada; um parágrafo Markdown comum pode alterar o alinhamento.

```
+-------------+
| MEU PROJETO |
+-------------+
```

Escolha a largura para seus leitores

O gerador informa a largura real e avisa quando ela ultrapassa a meta escolhida. Ele não reduz nem corta o banner automaticamente. Experimente um título menor ou uma fonte compacta e confira a prévia do README no GitHub.

Títulos, divisores e logotipos

Use divisores para instalação, uso e contribuições. Para um logotipo baseado em imagem, abra o conversor de imagens. Para comparar todas as fontes ou baixar PNG, use o gerador completo de texto.

Informação acessível

Leitores de tela podem ter dificuldade com arte ASCII. Escreva nomes, comandos e instruções essenciais em texto comum também. O banner deve complementar o conteúdo.

Seções prontas para README

Copie um exemplo ou personalize o texto e a moldura.

Título do projeto

README
+-------------+
| MEU PROJETO |
+-------------+
Personalizar

Seção de instalação

README
-- INSTALACAO --------------------------
Personalizar

Seção de uso

README
-- COMO USAR ---------------------------
Personalizar

Seção de contribuições

README
-- CONTRIBUIR --------------------------
Personalizar