37 lines
742 B
Markdown
37 lines
742 B
Markdown
<!-- file: docs/templates/CRATE_README_TEMPLATE.md -->
|
||
<!-- version: 1 -->
|
||
|
||
# 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)
|