Projeto simples
Uma apresentação curta, um comando funcional e notas para contribuir.
Crie um título para seu projeto ou um divisor de seção e copie o bloco Markdown completo. Sem cadastro ou instalação.
Use o banner acima, adicione os detalhes e baixe um arquivo Markdown.
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.
Uma apresentação curta, um comando funcional e notas para contribuir.
Um pequeno módulo reutilizável com um exemplo de importação.
Um comando de terminal com arquivo de entrada e resultado esperado.
Substituir os campos do README por este exemplo? Seu banner será mantido.
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.
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 | +-------------+ ```
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.
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.
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.
Copie um exemplo ou personalize o texto e a moldura.
+-------------+ | MEU PROJETO | +-------------+
-- INSTALACAO --------------------------
-- COMO USAR ---------------------------
-- CONTRIBUIR --------------------------