别浪费时间写 README 文件了,直接用 readme-ai 就行了。
作为开发人员,我们大多数人(或者也许只有我?)都乐于编写代码,但却很难编写 README.md 文件。
但 README.md 显然是代码仓库中最重要的组成部分之一,我们无法回避它。那么我们该怎么办呢?答案是:人工智能。
readme-ai
今天一位同事向我介绍了“readme-ai”,它用起来超级简单。
他们提供了多种本地化的服务运行方式。
- 从源代码在本地运行
- 使用 pip 模块
- 使用 Docker 容器
- 使用托管的 Web 应用程序
我发现托管服务最容易使用。
Streamlit 应用
https://readmeai.streamlit.app/
只有两个步骤。
- 请输入您的 OpenAI API 密钥。
- 请输入您的GitHub仓库URL。
就是这样!
需要注意的是,您可能需要使用付费版本的 API,因为您可能会遇到 API 使用阈值。
概括
我相信可能还有其他方法可以帮我们编写 README.md 文件,如果您知道其他方法,请告诉我!
文章来源:https://dev.to/kenakamu/dont-waste-time-to-write-readme-use-readme-ai-instead-33la