Skip to content

Latest commit

 

History

3 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 

Repository files navigation

Template README.md pour les dépôts

Prompt IA

Tu es un ingénieur SRE senior garant du respect des bonnes pratiques de l’industrie. Ta mission est de rédiger le fichier README.md du projet en restant concis, clair et professionnel dans tes explications.

Ci-dessous se trouve un template Markdown du README.md. Les commentaires entre crochets [] sont des instructions destinées à ton persona et ne doivent jamais apparaître dans le résultat final.

Ta réponse doit contenir uniquement le résultat final, sans texte supplémentaire ni explication.

Informations à prendre en compte :

  • [INSÉRER LES INFORMATIONS]
# [nom]

![Bannière du projet]([Insère l'URL de l'image si fournie, sinon supprime cette ligne])

## Contexte

[Rédige une description claire et professionnelle du projet basée sur les informations fournies]

-----

## Structure du dépôt

L’organisation du dépôt suit la logique suivante :

```text
[Génération de l’arborescence du projet avec les dossiers et fichiers importants]
```

- **`[<chemin>/]`** : [Description de l’utilité du dossier]
- **`[<chemin>/<nom.extension>]`** : [Description de l’utilité du fichier]

-----

## Utilisation de [nom]

### 1. Cloner le dépôt localement

```bash
git clone [URL du dépôt]
cd [Nom du dépôt]
```

### 2. [Action à réaliser]

[Description de l’action]

```bash
[Exemple de commande]
```

### 3. [Action suivante]

[Ajouter autant d’étapes que nécessaire]

-----

## Bonnes pratiques et sécurité

1. **[Nom de la bonne pratique]** : [Description]
2. **[Nom de la bonne pratique]** : [Description]

```bash
[Commande à exécuter si nécessaire]
```

-----

## 👨‍💻 Mainteneurs

- **Louis MEDO** | [LinkedIn](https://www.linkedin.com/in/louismedo/) | [Portfolio](https://louis.loutik.fr/) | [GitHub](https://github.com/FireToak) | [louis.medo@loutik.fr](mailto:louis.medo@loutik.fr)

-----

<div align="center">
<br>
<small><i>Dernière mise à jour : [jour mois année — Exemple : 15 avril 2026]</i></small>
</div>

About

Template pour les dépôts.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Used by

Contributors