ReadMeCreator With LLM

LLMを使用したReadMe Creator

Readme Creatorへようこそ！このツールは、インタラクティブなREADMEファイルを生成するプロセスを簡素化します。

特徴

• readmeテンプレートをすばやく作成します。
• ユーザーフレンドリーなプロンプトでテンプレートをカスタマイズします。
• インタラクティブで視覚的に魅力的なreadmeファイルを生成します。

はじめる

1. このリポジトリをクローンします：

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

2. 必要な依存関係をインストールします。

pip install -r requirements.txt

3. 環境変数としてエクスポートして、OpenAI APIキーを設定します。

 export OPEN_AI_KEY=your_openai_key_here

使用法

次のコマンドを実行して、readme作成者を開始します。

python src/readme_creator.py

プロンプトに従って、READMEテンプレートをカスタマイズします。このツールは、ルートディレクトリにインタラクティブなreadme.mdファイルを生成します。

例

事前に設計されたREADMEテンプレートと対応する出力のexamples/ディレクトリをご覧ください。

貢献

貢献を歓迎します！プルリクエストをお気軽に送信してください。

ライセンス

このプロジェクトは、MITライセンスに基づいてライセンスされています。詳細については、ライセンスファイルを参照してください。