Questions fréquentes
Que contient le README ?
Le nom du projet et une description en une ligne, puis les sections que vous remplissez : À propos, Fonctionnalités, Installation, Utilisation, Capture d'écran, Contribuer, Licence, Auteur et Remerciements. Les sections vides sont laissées de côté : le README ne contient que ce dont votre projet a besoin.
Le README peut-il être dans une autre langue ?
Oui. Choisissez l'anglais, l'espagnol, l'allemand ou le français comme langue du README : les titres et les phrases standard de Contribuer, Licence et Auteur sont écrits dans cette langue. Ce que vous saisissez vous-même reste tel quel.
Que sont les badges ?
De petites étiquettes en haut du README pour la licence, la version npm et les étoiles GitHub. Ce sont des images de shields.io que GitHub affiche ; notre aperçu les montre comme des cadres au lieu de les charger. Indiquez un dépôt GitHub ou un paquet npm pour obtenir ces badges.
Où mettre le fichier ?
Enregistrez-le sous le nom README.md dans le dossier principal de votre projet : GitHub, GitLab et npm l'affichent sur la page d'accueil du projet. La section Licence renvoie à un fichier LICENSE ; GitHub peut le créer pour vous à partir de ses modèles de licence.
Quelque chose est-il envoyé, et qu'est-ce qui compte comme une utilisation ?
Non, le README est créé dans votre navigateur et ce que vous saisissez ne quitte jamais votre appareil. Remplir le formulaire est gratuit : seuls la copie ou le téléchargement du README comptent comme une opération dans la limite quotidienne affichée au-dessus de l'outil. Notre serveur enregistre seulement ce compte et votre adresse réseau.