ReadMeCreator With LLM

使用llm的讀書我的創建者

歡迎來到讀書我的創建者！該工具簡化了生成交互式讀數文件的過程。

特徵

• 快速創建讀數模板。
• 使用用戶友好的提示自定義模板。
• 生成交互式和視覺上吸引人的讀數文件。

入門

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.md文件。

例子

查看examples/目錄中的預設的讀數模板及其相應的輸出。

貢獻

我們歡迎捐款！隨時提交拉力請求。

執照

該項目是根據MIT許可證獲得許可的 - 有關詳細信息，請參見許可證文件。