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许可证获得许可的 - 有关详细信息，请参见许可证文件。