Progetto semplice
Una breve presentazione, un comando funzionante e note per contribuire.
I banner ASCII aiutano a scansionare le sezioni README se restano compatti e leggibili.
Il tuo banner appare qui.
Il link del banner include il testo e le impostazioni che scegli di condividere.
Usa il banner qui sopra, aggiungi i dettagli del progetto e scarica un unico file Markdown.
Scegli un progetto Python semplice, una libreria o uno strumento da terminale. Adatta testi e comandi al tuo progetto; il banner attuale viene conservato.
Una breve presentazione, un comando funzionante e note per contribuire.
Un piccolo modulo riutilizzabile con un esempio di importazione.
Un comando da terminale con file di ingresso e risultato atteso.
Sostituire i campi del README con questo esempio? Il banner resterà invariato.
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.
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.
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.
Misura sul testo completo, con maiuscole e cornice scelte. Controlla il risultato sul dispositivo di destinazione.
== BUILD PASSING ==.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.