Le README.md — Présenter son projet

?

C'est quoi un README.md ?

Le README.md est le premier fichier qu'on regarde quand on visite un projet sur GitHub. Il s'affiche automatiquement sur la page principale de ton dépôt. C'est la vitrine de ton projet : il doit expliquer ce que c'est, comment l'utiliser, et comment y contribuer.

🏪

Le README, c'est comme la devanture d'un magasin. Quand tu passes devant une boutique, tu lis le nom, tu regardes la vitrine pour comprendre ce qu'ils vendent, les horaires… Sans ça, tu ne saurais pas si ça t'intéresse. Sur GitHub, le README joue ce rôle : sans lui, ton projet est une boîte mystérieuse que personne ne va ouvrir !

💡Sur GitHub, le fichier README.md à la racine de ton projet est automatiquement affiché sur la page principale de ton dépôt. Il n'y a rien à configurer — GitHub le détecte tout seul !

Md

C'est quoi le Markdown ?

Le Markdown est un langage de mise en forme très simple. En ajoutant quelques symboles autour du texte, tu peux créer des titres, du gras, des listes, des liens… sans écrire de HTML ! GitHub convertit automatiquement le Markdown en beau HTML affiché.

✍️ Ce que tu écris

# Mon super projet **Description :** Un portfolio créé avec HTML et CSS. ## Technologies - HTML5 - CSS3 - Git & GitHub [Voir le site](https://lien.com)

👁️ Ce que ça affiche

Mon super projet

Description : Un portfolio créé avec HTML et CSS.

Technologies

HTML5
CSS3
Git & GitHub

Voir le site

🔑

La syntaxe Markdown essentielle

Voici les éléments de base à connaître pour écrire un bon README :

Titres

# Titre principal (H1)
## Sous-titre (H2)
### Sous-sous-titre (H3)

Titre principal

Sous-titre

Sous-sous-titre

Mise en forme du texte

**texte en gras**
*texte en italique*
`du code inline`

texte en gras
texte en italique
du code inline

Listes et liens

- Élément 1
- Élément 2
- Élément 3

[Texte du lien](https://url.com)

Élément 1
Élément 2
Élément 3

Texte du lien

💡Dans VS Code, installe l'extension "Markdown Preview Enhanced" : elle te montre le rendu de ton README en temps réel à côté du code ! Clique droit sur le fichier → "Open Preview".

📐

La structure idéale d'un README

Un bon README contient toujours ces sections dans cet ordre :

# 🎨 Nom du projet > Une courte phrase qui résume ton projet (1-2 lignes max) - 🌐 **Lien vers le site :** [Voir le projet](https://ton-pseudo.github.io/ton-projet) - 📋 **Version actuelle :** v0.01.0 --- ## 📝 Description Explique en **2 à 5 phrases** ce que fait ton projet, dans quel contexte il a été créé, et à qui il s'adresse. ## 🛠️ Technologies utilisées - HTML5 / CSS3 - JavaScript - Git & GitHub ## 🚀 Fonctionnalités - Navigation avec menu responsive - Galerie de projets filtrables - Formulaire de contact ## 📁 Structure du projet ``` mon-site/ ├── index.html ├── patch-note.txt ├── README.md └── Assets/ ├── css/ ├── js/ └── img/ ``` ## 📋 Patch-notes Consulte le fichier [patch-note.txt](./patch-note.txt) pour l'historique complet. ## 👤 Auteur Créé par **Ton Prénom** — Projet scolaire 2025

👁️

À quoi ça ressemble sur GitHub ?

Voici comment ce README s'afficherait sur la page GitHub de ton projet :

📄 README.md — Aperçu GitHub

🎨 Mon Portfolio

Un portfolio créé avec HTML et CSS pour présenter mes projets web.

🌐 Voir le projet 📋 v0.01.0

📝 Description

Ce projet est un portfolio personnel réalisé dans le cadre d'un cours de développement web. Il présente mes créations et permet de me contacter directement.

🛠️ Technologies utilisées

HTML5 / CSS3
Git & GitHub

🚀 Fonctionnalités

Navigation responsive
Galerie de projets
Formulaire de contact

👤 Auteur

Créé par Alice Martin — Projet scolaire 2025

📁

Créer son README.md étape par étape

1

Dans VS Code, fais clic droit sur la racine de ton projet → "Nouveau fichier" → tape README.md (avec la majuscule et l'extension .md !)

2

Commence par le titre : # 🎨 Nom de ton projet

3

Ajoute une description courte, les technologies utilisées, et les fonctionnalités

4

Ajoute le lien vers ton site GitHub Pages (on le verra dans le cours suivant !)

5

Sauvegarde, puis fais git add . → git commit -m "Ajout du README" → git push

6

Va sur GitHub.com → ton dépôt → tu vois le README affiché automatiquement ! 🎉

⚠️Le fichier doit s'appeler exactement README.md (tout en majuscules, avec .md). GitHub ne reconnaît pas readme.md ou Readme.md sur certains systèmes. Et il doit être à la racine du projet, pas dans un sous-dossier !

🔗

Ajouter le lien GitHub Pages dans le README

Une fois ton site hébergé sur GitHub Pages (voir le cours suivant), tu dois ajouter le lien dans ton README pour que les visiteurs puissent cliquer directement dessus :

# 🎨 Mon Portfolio > Portfolio personnel créé avec HTML, CSS et JavaScript. - 🌐 **Lien du site :** [https://alice.github.io/mon-portfolio](https://alice.github.io/mon-portfolio) - 📋 **Version :** v1.00.0 - 👤 **Auteur :** Alice Martin

🌐Le lien GitHub Pages suit toujours ce format : https://TON-PSEUDO.github.io/NOM-DU-DEPOT. Remplace TON-PSEUDO par ton nom d'utilisateur GitHub et NOM-DU-DEPOT par le nom de ton dépôt !

✓

Résumé : les règles du README

✅ Fichier README.md à la racine — toujours avec la bonne casse

✅ Sections obligatoires : Titre, Description, Technologies, Fonctionnalités

✅ # = titre | **texte** = gras | - item = liste

✅ Ajoute toujours le lien GitHub Pages en haut du README

✅ Mets à jour le README à chaque grande évolution du projet

Le README.md —La carte d'identité de ton projet

Le README.md —
La carte d'identité de ton projet