readme ai

为简单，自定义和开发人员的生产率而设计。

快速链接

1. 概述

2. 演示

3. 特征

4. 入门

5. 配置

6. 例子

7. 贡献

重要的

访问官方文件以获取详细的指南和教程。

概述

readme-ai是一种开发工具，它会使用强大的存储库处理引擎和高级语言模型自动生成读数标记文件。只需提供通往代码库的URL或路径，即可生成结构良好的详细读数。

为什么要再读？

该工具旨在简化开发人员的文档流程，节省时间和精力，同时确保高质量的读数文件。关键好处包括：

• AI驱动：智能内容生成的利用语言模型。

• 一致性：确保跨项目的清洁，标准化的文档。

• 自定义：量身定制输出以满足您的项目要求。

• 语言不可知论：与大多数编程语言/框架一起使用。

• 节省时间：在不到一分钟的时间内生成全面的回教。

演示

从命令行运行：

readmeai-cli-demo.mov

直接在浏览器中运行：

readmeai-streamlit-demo.mov

---

特征

• 自动文档：从您的代码库自动生成全面的读数文件。

• 可自定义的输出：量身定制样式，格式，徽章，标头设计以及更多偏好。

• 灵活的后端：与OpenAI ， Ollama ， Anthropic ， Google Gemini无缝集成。

• 语言不可知论：与广泛的编程语言和项目类型兼容。

• 离线模式：在没有任何外部API调用的情况下，请脱机创建样板读数文件。

• 最佳实践：确保清洁，专业的文档，坚持降低最佳实践。

让我们看一下readme-ai创建的一些可能的自定义：

pip 针对大多数用户的推荐方法： ❯PIP安装readmeai pipx 使用PIPX在孤立的环境中使用readmeai ，确保与其他Python项目没有依赖性冲突： ❯pipx安装readmeai 紫外线 使用UV使用单个命令安装readmeai的最快方法： ❯紫外线工具安装readmeai Docker 要在容器化的环境中运行readmeai ，请从Docker Hub中获取最新的Docker Image： ❯码头拉Zeroxeli/readme-ai：最新 来自来源 点击扩展说明 克隆存储库： ❯git克隆https://github.com/eli64s/readme-ai 导航到readme-ai目录： ❯cd readme-ai 安装依赖项： ❯PIP安装-R设置/需求.txt 另外，可以使用下面的BASH脚本设置该项目： bash 运行设置脚本： ❯bash设置/设置 或者，使用poetry来建立该项目： 诗 使用诗歌安装依赖性： ❯诗歌安装 重要的 要使用人类和Google Gemini客户端，需要额外的依赖性。安装包含以下附加功能的软件包： 人类： ❯PIP安装“ readmeai [Anthropic]” Google Gemini： ❯PIP安装“ readmeai [Google-generativeai]” 安装多个客户端： ❯PIP安装“ readmeai [拟人，Google-generativeai]” ？运行CLI 1。设置环境变量 与Openai： ❯导出OpenAi_Api_key = <your_api_key>＃或Windows用户：❯设置OpenAi_Api_Key = <your_api_key> 其他提供商（Ollama，Anthropic，Google Gemini） 霍拉马 有关设置Ollama API的更多信息，请参阅Ollama文档。这是一个基本示例： 从Ollama存储库中获取您的首选模型： ❯Ollama拉米斯特拉尔：最新 启动Ollama服务器并设置OLLAMA_HOST环境变量： ❯导出ollama_host = 127.0.0.1 && ollama服务 人类 导出您的拟人API密钥： ❯导出Anthropic_api_key = <your_api_key> Google双子座 导出您的Google Gemini API密钥： ❯导出Google_api_key = <your_api_key 2。生成一个读书文件 运行以下命令，用您自己的存储库URL替换： ❯readmeai-Repository https://github.com/eli64s/readme-ai-api Openai 重要的 默认情况下，使用gpt-3.5-turbo模型。当更高级模型时，可能会产生较高的成本。 与Ollama一起运行，将llama3设置为模型： ❯-readmeai -api ollama -model llama3 -repository https://github.com/eli64s/readme-eadme-ai- 以Anthropic运行： ❯-readmeai -api人类-M Claude-3-5-Sonnet-20240620 -r https：//github.com/eli64s/readme-ai- 与Google Gemini一起运行： ❯readmeai -api gemini -M gemini-1.5-flash -r https：//github.com/eli64s/readme-eadme-ai 使用local目录路径： readmeai - repository/path/to/your/project 添加更多自定义选项： ❯readmeai -repository https://github.com/eli64s/readme-ai - 输出readmeai.md -api Openai - 模型GPT-4 - Badge-Color A931EC - 式扁平平方 - 头部式紧凑型 - toc风格的折叠 - 温度0.9 - 深度2 - 图片LLM - emojis Docker 使用OpenAI客户端运行Docker容器： ❯docker run -it -rm -e Openai_api_key = $ openai_api_key -v“ $（pwd）”：/app zeroxeli/readme-ai：最新 -Repository https://github.com/eli64s/readme-ai -api Openai 来自来源 点击扩展说明 bash 如果您使用bash脚本从源安装了项目，请运行以下命令： 激活虚拟环境： ❯conda激活readmeai 运行CLI： ❯python3 -m readmeai.cli.main -r https：//github.com/eli64s/readme-ai 诗 激活虚拟环境： ❯诗歌外壳 运行CLI： ❯诗歌运行python3 -m readmeai.cli.main -r https：//github.com/eli64s/readme-eadme-ai 简化 直接在浏览器中直接使用readme-ai，无需安装。有关更多详细信息，请参见readme-ai-streamlit存储库。 测试 PYTEST和NOX框架用于开发和测试。 使用诗歌安装依赖项： ❯诗歌安装 - 与开发，测试 使用pytest运行单元测试套件： ❯进行测试 使用NOX运行针对Python 3.9、3.10、3.11和3.12的测试套件： ❯进行测试诺克斯 提示 NOX是一种自动化工具，可在多个Python环境中自动进行测试。它用于确保不同Python版本的兼容性。 配置 使用以下CLI选项自定义您的自动化信息： 选项 描述 默认 --align 标题中的文本对齐 center --api LLM API服务提供商 offline --badge-color 徽章颜色名称或十六进制代码 0080ff --badge-style 徽章图标样式类型 flat --header-style 标题模板样式 classic --toc-style 目录样式 bullet --emojis 将表情符号添加到ReadMe标题部分 False --image 项目徽标图像 blue --model 使用特定的LLM模型 gpt-3.5-turbo --output 输出文件名 readme-ai.md --repository 存储库URL或本地目录路径 None --temperature 内容生成的创造力水平 0.1 --tree-depth 目录树结构的最大深度 2 运行以下命令以查看所有可用选项： ❯redemeai--螺旋 请访问官方文档以获取有关配置选项，示例和最佳实践的更多详细信息。 例子 查看readme-ai在各种技术堆栈中生成的示例readme文件： 技术 示例输出 存储库 描述 readme-ai readme-ai.md readme-ai Readme-AI项目 apache flink readme-pyflink.md pyflink-poc Pyflink项目 简化 readme-streamlit.md readme-ai-streamlit 简化Web应用程序 Vercel＆npm readme-vercel.md GitHub-Readme-Quotes 动词部署 Go＆Docker readme-docker-go.md Docker-GS-Ping Dockerized Go应用程序 Fastapi＆Redis readme-fastapi-redis.md 异步-ML推导 异步ML推理服务 爪哇 readme-java.md 最小值 极简主义Todo Java应用程序 Postgresql＆DuckDB readme-postgres.md 布埃纳维斯塔 Postgres代理服务器 科特林 readme-kotlin.md Android-Client Android客户端应用程序 离线模式 离线mode.md Litellm LLM API服务 在示例目录中查找其他读数示例。 路线图 释放具有增强文档管理功能的readmeai 1.0.0 。 开发Vscode Extension ，以直接在编辑器中生成读数文件。 开发GitHub Actions以自动化文档更新。 添加badge packs以提供其他徽章样式和选项。 代码覆盖范围，CI/CD状态，项目版本等。 贡献 欢迎捐款！请阅读入门贡献指南。 贡献指南：了解我们的贡献过程和编码标准。 ？报告问题：发现一个错误？让我们知道！ 开始讨论：有想法或建议？我们很想听听您的来信。 致谢 Shields.io 简单图标 Aveek-Saha/github profile-badges iLeriayo/markdown-badges TANDPFUN/SKILL-ICON 执照 版权所有©2023 README-AI。 根据MIT许可发布。