Que fait write-project-readme ?
Installez une compétence Codex basée sur les preuves pour des README de projet complets.
Aperçu
Cette compétence automatise la création de fichiers README pour vos projets en analysant le code source et la structure du projet. Elle garantit que la documentation est complète, précise et conforme aux meilleures pratiques.
Fonctionnalités
- Génération automatique de README
- Analyse basée sur les preuves du code et de la structure du projet
- Sections personnalisables (description, installation, utilisation, etc.)
- Support de plusieurs langages et frameworks
Utilisation
- Assurez-vous que Codex CLI est installé et configuré.
- Exécutez la compétence dans votre répertoire de projet :
codex run montasim/write-project-readme
- Suivez les instructions pour personnaliser le README généré.
Configuration
Aucune configuration supplémentaire n'est nécessaire. La compétence détecte automatiquement les informations pertinentes de votre projet.
Exemple
# Mon Projet
## Description
Ce projet fait X, Y, et Z.
## Installation
```bash
npm install
Utilisation
npm start
## Contribution
Les contributions sont les bienvenues ! Veuillez consulter le fichier CONTRIBUTING.md pour plus de détails.
## Licence
MIT
Support
Pour toute question ou problème, veuillez ouvrir une issue sur le dépôt GitHub.
Remarques
- Assurez-vous que votre projet est bien structuré avant d'exécuter la compétence.
- La compétence peut être réexécutée pour mettre à jour le README existant.