Projet simple
Une courte présentation, une commande fonctionnelle et des notes pour contribuer.
Guide
Art ASCII pour GitHub README
Les bannieres ASCII rendent les sections README plus lisibles si elles restent compactes.
Créer la bannière du projet
Aperçu ASCII
Votre bannière apparaît ici.
Le lien de la bannière contient le texte et les réglages choisis.
Composer votre README
Utilisez la bannière ci-dessus, ajoutez les détails et téléchargez un fichier Markdown.
Partir d’un exemple complet
Choisissez un projet Python simple, une bibliothèque ou un outil en ligne de commande. Adaptez les textes et les commandes à votre projet ; votre bannière est conservée.
Bibliothèque Python
Un petit module réutilisable avec un exemple d’importation.
Outil en ligne de commande
Une commande avec un fichier d’entrée et le résultat attendu.
Remplacer les champs du README par cet exemple ? Votre bannière sera conservée.
Aperçu du README
Markdown complet
Ces champs restent dans cette page et ne figurent pas dans le lien de la bannière. Installation et utilisation sont copiées comme code, description et contributions comme texte simple.
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 :
``` +------------+ | MY PROJECT | +------------+ ```
Utilisez un bloc à trois accents graves sans étiquette de langage, ainsi aucun coloriseur de syntaxe ne recolore votre art.
Choisissez la bonne largeur
Mesure du texte complet avec la casse et le cadre choisis. Vérifiez le résultat sur l’appareil de destination.
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.