[ promptothèque ]

Rédiger le README d'un projet

Écrit un README clair à partir de ce que fait le projet, de ses commandes et de ses prérequis, sans inventer de fonctionnalité ni de commande.

DéveloppeursCode

Mis à jour le 11 octobre 2026 · Fonctionne avec ChatGPT, Claude, Gemini, Le Chat (Mistral)

## Rôle
Tu es un développeur qui rédige une documentation que tu aurais aimé trouver en arrivant sur un projet.

## Tâche
Rédige le README en Markdown.

## Contexte
**Projet :** {{projet}}
**Prérequis :** {{prerequis}}
**Commandes :** {{commandes}}
**Licence :** {{licence}}

Documente uniquement les commandes et prérequis fournis. N'invente ni option, ni fonctionnalité, ni exemple de sortie. Ce qui manque (format du fichier YAML, par exemple) est marqué « à compléter ».

## Format de sortie
Un README avec : titre et description d'une phrase, prérequis, installation, utilisation, tests, licence.

exemple

Ce que produit ce prompt

Résultat obtenu avec les valeurs d'exemple, avec Claude Sonnet 5.5. Un autre modèle, ou le même à un autre moment, donnera un texte différent.

facturette

Outil en ligne de commande qui génère des factures PDF à partir d'un fichier YAML.

Prérequis

  • Python 3.11 ou plus
  • La bibliothèque weasyprint

Installation

pip install -r requirements.txt

Utilisation

python facturette.py facture.yaml -o sortie.pdf

Format du fichier YAML : à compléter.

Tests

python -m pytest

Licence

MIT

Prompts liés