Rédigez un README clair en 10 minutes grâce à GitHub Copilot

Ouvrez votre dépôt et créez le fichier README

Ouvrez votre dépôt sur GitHub dans votre navigateur. Vous arriverez sur la page principale affichant les fichiers de votre projet. Cherchez une liste de fichiers ; si vous venez de créer le dépôt, vous ne verrez peut-être qu'un fichier .gitignore ou rien du tout. En haut à droite de la liste des fichiers, cliquez sur Ajouter un fichier (Add file) et choisissez Créer un nouveau fichier (Create new file). Nommez le fichier README.md. L'extension .md signifie « Markdown », un moyen simple de formater le texte avec des symboles comme # pour les titres.

Vous verrez un éditeur vide avec un texte d'aide : « Écrire un nouveau fichier dans… » (Write a new file in …). Le nom de fichier README.md indique à GitHub qu'il s'agit de la page d'accueil du projet.

Vous saurez que cela a fonctionné lorsque vous verrez le nom de fichier README.md en haut de l'éditeur et que le titre de la page indiquera « Créer un nouveau fichier » (Create new file).

Demandez à Copilot de générer la structure du README

Le fichier étant ouvert, appuyez sur le bouton Demander à Copilot (Ask Copilot) (généralement une icône de chat ou une étincelle) dans le coin supérieur droit de l'éditeur. Si vous ne le voyez pas, cherchez une icône Copilot dans la barre d'outils ou utilisez le raccourci Ctrl+I (Windows/Linux) ou Cmd+I (Mac). Un panneau de discussion s'ouvrira sur la droite.

Dans la boîte de discussion, tapez :

Appuyez sur Entrée. Copilot répondra avec une structure suggérée utilisant des titres Markdown comme # Description, ## Fonctionnalités, etc. Il peut également ajouter un court paragraphe d'exemple sous chaque titre.

Vous saurez que cela a fonctionné lorsque vous verrez une liste de titres et de brèves descriptions apparaître dans l'éditeur, remplaçant la page blanche.

Remplissez la description du projet

Faites défiler jusqu'à la section # Description créée par Copilot. Remplacez le texte d'exemple par une explication claire et en une phrase de votre projet. Par exemple, si votre projet est un script Python qui compte les mots, écrivez :

Vous saurez que cela a fonctionné lorsque la description se lira comme une introduction conviviale et s'intégrera naturellement sous le titre.

Énumérez les fonctionnalités du projet

Sous le titre ## Fonctionnalités, Copilot a probablement ajouté une liste à puces. Remplacez chaque puce par une phrase courte et active décrivant ce que fait votre projet. Pour un compteur de mots, cela pourrait ressembler à :

• Fonctionne avec les fichiers .txt sous Windows, macOS et Linux
• Léger et s'exécute en quelques secondes
• Aucune bibliothèque externe requise

Vous saurez que cela a fonctionné lorsque la liste montrera clairement ce que le projet peut faire, en utilisant un langage simple.

Ajoutez les instructions d'installation

Faites défiler jusqu'à la section ## Installation. Copilot suggère généralement des commandes comme pip install ou git clone. Remplacez le texte d'exemple par des instructions étape par étape pour votre système d'exploitation. Pour un projet Python adapté aux débutants, écrivez :

python --version Si vous voyez Python 3.x, vous êtes prêt. 2. Téléchargez ou clonez ce projet : git clone https://github.com/votre-nom-utilisateur/votre-dépôt.git 3. Accédez au dossier du projet : cd votre-dépôt 4. Installez le paquet requis (le cas échéant) : pip install -r requirements.txt (S'il n'y a pas de requirements.txt, ignorez cette étape.)

Vous saurez que cela a fonctionné lorsque les instructions seront suffisamment claires pour qu'une personne ayant des compétences informatiques de base puisse les suivre sans confusion.

Rédigez un exemple d'utilisation

Sous le titre ## Utilisation, Copilot ajoute souvent un bloc de code avec une commande comme python wordcounter.py. Remplacez-le par un exemple simple, prêt à être copié-collé. Pour un compteur de mots, écrivez :

python wordcounter.py sample.txt

Vous saurez que cela a fonctionné lorsque l'exemple sera court, utilisera de vrais noms de fichiers et montrera exactement ce qu'il faut taper.

Choisissez une licence et ajoutez-la

Faites défiler jusqu'à la section ## Licence. Copilot peut suggérer un texte d'exemple comme « Licence MIT » ou « Apache 2.0 ». Remplacez-le par une brève explication et un lien vers le fichier de licence. Pour les débutants, la licence MIT est simple et largement utilisée. Écrivez :

Vous saurez que cela a fonctionné lorsque la section de licence indiquera clairement le type de licence et renverra à un fichier nommé LICENSE dans votre dépôt.