Exemple de README.md

Lecture seule - mission station météo
Ceci est un exemple complet de README pour une autre mission que le volcan (des pressions atmosphériques, et un seuil d'aberrance de 8 hPa au lieu de 20). Sers-t'en comme modèle à adapter à ton propre projet, ne le copie pas. Remarque : on n'affiche pas les valeurs dans le README, on en parle (de quoi il s'agit, les unités, le genre de chiffre, et le seuil choisi).
Le texte Markdown (ce que j'écris)
# README - Analyse des pressions de la station météo ## À quoi sert mon programme Mon programme résume une série de relevés de pression atmosphérique pris à une station météo, et il repère la mesure aberrante : celle qui ne ressemble pas aux autres (le plus souvent une erreur de capteur). ## Les ENTRÉES (les données de départ) - Une liste de mesures de pression atmosphérique. - L'unité de ces mesures est l'hectopascal (hPa). - Une pression *normale* tourne autour de la valeur habituelle de la station ; une pression *anormale* s'en écarte beaucoup. - Le seuil que j'ai choisi pour décider qu'une mesure est aberrante : un écart de plus de **8 hPa** avec la moyenne. ## Les TRAITEMENTS (ce que le programme calcule) - Compter les relevés (combien il y a de mesures). - Calculer la moyenne : additionner toutes les pressions avec une boucle, puis diviser par le nombre de relevés. - Calculer l'étendue : la plus grande pression moins la plus petite. - Détecter la valeur aberrante : parcourir les mesures et repérer celle dont l'écart avec la moyenne dépasse le seuil de 8 hPa. ## Les SORTIES (ce que le programme produit) ### Affichage Affiche à l'écran le nombre de mesures, la moyenne, l'étendue et la mesure aberrante qui a été repérée. ### Données enregistrées Enregistre le même rapport dans un fichier `rapport-pressions.csv`. ## Pourquoi un seuil de 8 hPa ? D'un jour à l'autre, la pression à la station ne bouge que de quelques hectopascals. J'ai donc choisi 8 hPa : un écart plus grand que ça avec la moyenne veut dire que la mesure est suspecte (le capteur a sûrement été déplacé ou exposé à un coup de vent), pas une vraie variation de la météo. > Astuce : le Markdown, c'est juste du texte avec quelques symboles > simples (`#` pour les titres, `-` pour les listes).
Le rendu (ce que ça donne)

README - Analyse des pressions de la station météo

À quoi sert mon programme

Mon programme résume une série de relevés de pression atmosphérique pris à une station météo, et il repère la mesure aberrante : celle qui ne ressemble pas aux autres (le plus souvent une erreur de capteur).

Les ENTRÉES (les données de départ)

  • Une liste de mesures de pression atmosphérique.
  • L'unité de ces mesures est l'hectopascal (hPa).
  • Une pression normale tourne autour de la valeur habituelle de la station ; une pression anormale s'en écarte beaucoup.
  • Le seuil que j'ai choisi pour décider qu'une mesure est aberrante : un écart de plus de 8 hPa avec la moyenne.

Les TRAITEMENTS (ce que le programme calcule)

  • Compter les relevés (combien il y a de mesures).
  • Calculer la moyenne : additionner toutes les pressions avec une boucle, puis diviser par le nombre de relevés.
  • Calculer l'étendue : la plus grande pression moins la plus petite.
  • Détecter la valeur aberrante : parcourir les mesures et repérer celle dont l'écart avec la moyenne dépasse le seuil de 8 hPa.

Les SORTIES (ce que le programme produit)

Affichage

Affiche à l'écran le nombre de mesures, la moyenne, l'étendue et la mesure aberrante qui a été repérée.

Données enregistrées

Enregistre le même rapport dans un fichier rapport-pressions.csv.

Pourquoi un seuil de 8 hPa ?

D'un jour à l'autre, la pression à la station ne bouge que de quelques hectopascals. J'ai donc choisi 8 hPa : un écart plus grand que ça avec la moyenne veut dire que la mesure est suspecte (le capteur a sûrement été déplacé ou exposé à un coup de vent), pas une vraie variation de la météo.

Astuce : le Markdown, c'est juste du texte avec quelques symboles simples (# pour les titres, - pour les listes).
Écrire mon propre README (éditeur) Retour au cours