871 B
871 B
Modèle de README de crate
Ce modèle est une aide de rédaction. Supprimer les instructions et sections non applicables après analyse réelle de la crate.
<nom-de-crate>
Objectif
Périmètre
Responsabilités
Hors périmètre
Fonctionnalités disponibles
Surface publique principale
Présenter les catégories d’API ou façades sans recopier USAGE.md.
Binaire(s)
Supprimer cette section si la crate ne fournit aucun binaire.
Relations avec le workspace
Statut et limites
Documentation
- Guide d’utilisation :
USAGE.md - Travaux restant à réaliser :
TODO.md - Historique des changements :
CHANGELOG.md
Après copie du modèle à la racine d’une crate, transformer ces références en liens relatifs vers les fichiers locaux.