Les en-têtes ASCII font ressortir un README
Un README ordinaire commence par une ligne de texte. Un excellent commence par une bannière. L'art ASCII donne à votre projet un en-tête reconnaissable, des séparateurs de section et des badges d'état sans ajouter de fichiers image au dépôt — ce n'est que du texte, donc cela se charge instantanément et fonctionne dans tout visualiseur Git.
Utilisez toujours un bloc de code
Le Markdown de GitHub affiche le texte normal de façon proportionnelle, ce qui détruit l'alignement ASCII. Placez l'art dans un bloc de code pour qu'il s'affiche à chasse fixe :
```__ __ _ _ _ _ ___| \/ | | | | | | | / __|| |\/| | |_| | |_| \__ \|_| |_|\__, |\___/|___/|___/```
Utilisez un bloc à trois accents graves sans étiquette de langage, ainsi aucun coloriseur de syntaxe ne recolore votre art.
Choisissez la bonne largeur
Les README se lisent sur de larges écrans de bureau mais aussi en aperçus mobiles étroits et dans la liste de fichiers de GitHub. Visez 80-100 caractères : assez large pour un en-tête affirmé, assez étroit pour ne pas défiler latéralement sur téléphone. Pour les séparateurs de sous-section, plus court vaut mieux.
Où l'utiliser
- La bannière du titre du projet tout en haut.
- Des séparateurs de section au-dessus d'Installation, Usage et Licence.
- De simples marqueurs d'état comme
== BUILD PASSING ==. - Un logo ASCII généré à partir de l'icône de votre application.
Gardez-le accessible
Les lecteurs d'écran lisent l'art ASCII caractère par caractère, n'enfouissez donc pas d'information essentielle dans l'art. Gardez un titre texte normal à côté de la bannière pour que la page ait du sens sans elle.