📑 Le fichier README.md en projet Git/GitHub

Cours pour BTS SIO – option SLAM

1) À quoi sert un README.md ?

Le fichier README.md est la page d’accueil d’un projet sur GitHub (ou tout dépôt Git).
Il est écrit en Markdown, un langage de balisage léger, et s’affiche automatiquement quand on ouvre le dépôt.

Ses rôles principaux :

• Présenter rapidement le projet à toute personne qui arrive sur le dépôt.
• Donner les instructions pour installer, configurer et utiliser le projet.
• Fournir des informations pour contribuer (règles, contact, licence, etc.).

2) Que doit contenir un README ?

Un bon README doit être clair, concis et structuré. On retrouve généralement :

• Nom du projet et logo éventuel.
• Description : à quoi sert ce projet ? quel problème il résout ?
• Installation : étapes pour installer les dépendances et lancer le projet.
• Utilisation : exemples de commandes ou d’utilisation du code.
• Fonctionnalités : ce que le projet sait faire.
• Technologies utilisées : langages, frameworks, bibliothèques.
• Auteurs / contributeurs.
• Licence (MIT, GPL, etc.).

3) Markdown : la syntaxe de base

🔹 Titres

# Titre principal
## Sous-titre
### Sous-sous-titre

🔹 Texte

**Gras**
*Italique*
~~Barré~~

🔹 Listes

- Élément 1
- Élément 2
  - Sous-élément

1. Premier
2. Deuxième
3. Troisième

🔹 Liens et images

[Lien vers Google](https://www.google.com)
![Logo du projet](images/logo.png)

🔹 Code

Voici du `code` en ligne.

```python
def hello():
    print("Hello Markdown")
```

🔹 Tableaux

| Colonne 1 | Colonne 2 |
|-----------|-----------|
| Valeur A1 | Valeur A2 |
| Valeur B1 | Valeur B2 |

🔹 Séparateur

---