8个版本

0.2.1 2023年7月31日
0.2.0 2023年7月12日
0.1.5 2023年5月21日

#776 in 开发工具

GPL-3.0-only

105KB
2.5K SLoC

✍️ 写入内容

跨平台为开发项目自动生成README.md

animated

写入内容 是一个旨在简化创建软件开发项目完整 README.md 文件过程的工程项目。写入内容的主要目的是从您的项目中自动提取相关信息,并为您生成一个格式良好的 README.md 文件,其中包括项目名称、描述、仓库名称、使用和配置步骤、资金详情以及合作者等重要信息。

写入内容主要从项目的配置文件中提取信息。具体的配置文件类型取决于项目,但流行的例子包括 Cargo.tomlpackage.jsoncomposer.json 等。要充分发挥写入内容的作用,请查看您的配置文件。

目录

⚙️ 配置

如果您选择使用 cargo 安装应用程序,请确保您的计算机上已安装 Rust 工具链。您可以在 此处 找到安装说明。

⬇️ 安装

Cargo

cargo install writeme

Homebrew

brew tap writeme-project/writeme && brew install writeme

🎈 使用

就像写一样简单

writeme 

或者选择不同的路径

writeme --path 'path/to/your/project'

使用 写入内容 --help 查看所有可用选项。

如果您想了解更多,请阅读 wiki

📄 许可证

GNU通用公共许可证

✍️ 作者

写入内容 自动生成

依赖

~22–39MB
~669K SLoC