Skip to content

Instantly share code, notes, and snippets.

@marc-gavanier
Last active May 19, 2022 07:49
Show Gist options
  • Save marc-gavanier/8e2a2a14a888deb80978373e51682bfb to your computer and use it in GitHub Desktop.
Save marc-gavanier/8e2a2a14a888deb80978373e51682bfb to your computer and use it in GitHub Desktop.
Exemple de Readme en Français

[Titre]

À propos

[Courte description à propos de pourquoi le projet existe]

Table des matières

Prérequis

[Liste de tous les éléments nécessaires pour le bon fonctionnement du projet avec description + lien vers la documentation]

Installation

[Étapes avec exemples des commandes à lancer pour installer le projet en local]

Utilisation

[### Sous-titre + description avec exemple des commandes à lancer pour l'ensemble des actions disponibles à l'utilisation dans un mode de développement]

Contribution

[### Sous-titre + description avec exemple des commandes à lancer pour l'ensemble du flux de contribution sur le dépôt]

Construit avec

Langages & Frameworks

[Liste de tout ce qui permet la confection du projet avec description + lien vers la documentation]

Outils

CI

[Liste de tout ce qui permet l'intégration automatisée du projet avec description + lien vers la documentation et mise en avant des comptes, organisations et variables]

Déploiement

[Liste de tout ce qui permet le déploiement du projet avec description + lien vers la documentation et mise en avant des comptes, organisations et variables]

Documentation

[Lien vers documentations externes ou documentation embarquée ici avec table des matières]

Gestion des versions

Afin de maintenir un cycle de publication claire et de favoriser la rétrocompatibilité, la dénomination des versions suit la spécification décrite par la Gestion sémantique de version

Les versions disponibles ainsi que les journaux décrivant les changements apportés sont disponibles depuis [la page des Releases][mettre le lien ici].

Licence

Voir le fichier LICENSE du dépôt.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment