Bannière ASCII pour code source et README
Transformez un nom court en titre qui se voit dans un fichier ou un README. Entourez-le de commentaires, tenez la largeur, copiez.
Paramètres
Conseils
Un nom court, pas une phrase
La bannière est une grille de tout petits caractères qui forment de grandes lettres. Un nom aussi court qu’une fonction ou un fichier — init, main — garde ces formes lisibles. Une phrase entière use tant de cellules qu’on ne lit plus le mot. Deux mots ? Mettez-les sur deux lignes pour que chacun reste assez grand.
Les marques de commentaire comptent dans la largeur de ligne
Quand vous enveloppez la bannière en commentaires, chaque ligne gagne des caractères comme // et des espaces d’indentation. L’éditeur les compte aussi. Si le fichier tient à 80 caractères par ligne, mettez la largeur à 80. Ici ça peut sembler bon et déborder après collage. Ajuster à la largeur réduit jusqu’à ce que le bloc copié tienne.
Dans un /* */, un */ du dessin termine le commentaire
En C et en Java, un commentaire va de /* au premier */. Si le remplissage dessine * et / côte à côte, la suite est lue comme du vrai code. Cette page insère un espace pour l’éviter. Un remplissage # ou . ne dessine jamais la paire. Envelopper chaque ligne avec // n’a pas de fermeture.
README et fichiers source n’acceptent pas les mêmes caractères
Un README accepte en général n’importe quel caractère. Certains arbres source — style noyau Linux, anciens contrôleurs — n’acceptent que lettres et symboles anglais. Des aplats comme █ se lisent bien dans un README et y sont refusés. Avant de coller dans ces fichiers, activez ASCII seulement et écrivez le nom en lettres anglaises.
Même en commentaires, restez dans les 80 colonnes
Écarter les lettres change l’allure du titre. Ajoutez les caractères qui en font un commentaire, et une ligne dépasse les 80 colonnes avant qu’on s’en rende compte. Surveillez ce budget.
Cas d'utilisation courants
En tête d’un fichier source
Placez un nom de module court en tête d’un .c ou .py, en commentaires, à 80 caractères par ligne. C’est du texte ordinaire : le diff montre les mêmes lettres.
Comme titre d’un README
Ouvrez un README GitHub avec le nom du projet en bannière. Entourez-le d’une clôture : pas d’hébergeur d’images, pas de lien cassé si le fichier bouge.
À l’ouverture du terminal
Collez-le dans le message d’accueil, un fichier de démarrage du shell ou tmux. Une session SSH n’affiche pas d’image ; elle affiche ces lettres.
Pour marquer une section dans un script
Placez une bannière compacte au-dessus d’une cible Makefile ou d’un fragment de déploiement. Pas de police d’interface : uniquement des caractères déjà dans le fichier.
Dans la description d’une pull request
Si le changement est une commande ou un binaire nommé, mettez une bannière clôturée dans la description de la pull request. Les relecteurs voient les mêmes lettres dans chaque client.