ReadMeCreator With LLM

ReadMe Créateur utilisant LLM

Bienvenue chez Readme Creator! Cet outil simplifie le processus de génération de fichiers de lecture interactifs.

Caractéristiques

• Créez rapidement des modèles ReadMe.
• Personnalisez les modèles avec des invites conviviales.
• Générez des fichiers de lecture interactifs et visuellement attrayants.

Commencer

1. Cloner ce référentiel:

git clone https://github.com/ashishpatel26/readme-creator-with-LLM.git
cd readme-creator

2. Installez les dépendances requises:

pip install -r requirements.txt

3. Configurez votre clé API OpenAI en l'exportant en tant que variable d'environnement:

 export OPEN_AI_KEY=your_openai_key_here

Usage

Exécutez la commande suivante pour démarrer le Créateur ReadMe:

python src/readme_creator.py

Suivez les invites pour personnaliser votre modèle de lecture. L'outil générera un fichier readme.md interactif dans le répertoire racine.

Exemples

Consultez les examples/ répertoire pour les modèles de lecture pré-conçus et leur sortie correspondante.

Contributif

Nous accueillons les contributions! N'hésitez pas à soumettre des demandes de traction.

Licence

Ce projet est autorisé en vertu de la licence MIT - voir le fichier de licence pour plus de détails.