Guida

ASCII art per GitHub README

I banner ASCII aiutano a scansionare le sezioni README se restano compatti e leggibili.

Componi il tuo README

Usa il banner qui sopra, aggiungi i dettagli del progetto e scarica un unico file Markdown.

Parti da un esempio completo

Scegli un progetto Python semplice, una libreria o uno strumento da terminale. Adatta testi e comandi al tuo progetto; il banner attuale viene conservato.

Progetto semplice

Una breve presentazione, un comando funzionante e note per contribuire.

Libreria Python

Un piccolo modulo riutilizzabile con un esempio di importazione.

Strumento da terminale

Un comando da terminale con file di ingresso e risultato atteso.

Scarica gli esempi funzionanti (ZIP, in inglese)

Anteprima README

Anteprima README
Markdown completo

Questi campi restano nella pagina e non entrano nel link di condivisione del banner. Installazione e utilizzo sono copiati come codice; descrizione e contributi come testo semplice.

Le intestazioni ASCII fanno risaltare un README

Un README banale apre con una riga di testo. Uno ottimo apre con un banner. L'ASCII art dà al tuo progetto un'intestazione riconoscibile, divisori di sezione e badge di stato senza aggiungere file immagine al repository — è solo testo, quindi carica all'istante e funziona in qualsiasi viewer Git.

Usa sempre un blocco di codice

Il Markdown di GitHub mostra il testo normale in modo proporzionale, distruggendo l'allineamento ASCII. Racchiudi l'arte in un blocco di codice così viene reso in monospazio:

```
+------------+
| MY PROJECT |
+------------+
```

Usa un blocco con tripli backtick senza tag di linguaggio così nessun evidenziatore di sintassi ricolora l'arte.

Scegli la larghezza giusta

Misura sul testo completo, con maiuscole e cornice scelte. Controlla il risultato sul dispositivo di destinazione.

Dove usarlo

  • Il banner del titolo del progetto in cima.
  • Divisori di sezione sopra Installazione, Uso e Licenza.
  • Semplici marcatori di stato come == BUILD PASSING ==.
  • Un logo ASCII generato dall'icona della tua app.

Mantienilo accessibile

Gli screen reader leggono l'ASCII art carattere per carattere, quindi non nascondere informazioni essenziali dentro l'arte. Tieni un titolo testuale normale accanto al banner così la pagina ha senso anche senza.

Genera un banner per README