ReadMeCreator With LLM

Readme -Schöpfer verwenden LLM

Willkommen im Readme -Schöpfer! Dieses Tool vereinfacht den Prozess der Generierung interaktiver ReadMe -Dateien.

Merkmale

• Erstellen Sie schnell Readme -Vorlagen.
• Passen Sie Vorlagen mit benutzerfreundlichen Eingabeaufforderungen an.
• Generieren Sie interaktive und visuell ansprechende Readme -Dateien.

Erste Schritte

1. Klonen Sie dieses Repository:

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

2. Installieren Sie die erforderlichen Abhängigkeiten:

pip install -r requirements.txt

3. Richten Sie Ihren OpenAI -API -Schlüssel ein, indem Sie sie als Umgebungsvariable exportieren:

 export OPEN_AI_KEY=your_openai_key_here

Verwendung

Führen Sie den folgenden Befehl aus, um den Readme -Schöpfer zu starten:

python src/readme_creator.py

Befolgen Sie die Eingabeaufforderungen, Ihre Readme -Vorlage anzupassen. Das Tool generiert im Stammverzeichnis eine interaktive Readme.md -Datei.

Beispiele

Schauen Sie sich die examples/ Verzeichnisse für vorgezeichnete Readme-Vorlagen und deren entsprechende Ausgabe an.

Beitragen

Wir begrüßen Beiträge! Fühlen Sie sich frei, Pull -Anfragen einzureichen.

Lizenz

Dieses Projekt ist unter der MIT -Lizenz lizenziert - Einzelheiten finden Sie in der Lizenzdatei.