#cargo #dependencies #readme

bin+lib deps-readme

一个用于生成包含 Rust 项目依赖项的 README.md 文件的工具

1 个不稳定版本

0.1.0 2023年3月25日

#20#readme

MIT 许可协议

13KB
108 代码行

deps-readme

  • 状态:进行中

cargo-deps-readme 是一个 Rust 包,简化了创建包含 crate 依赖项列表的 README.md 文件的过程。此包可用于快速生成在 Cargo.toml 文件中指定的依赖项的格式化和组织列表。

用法

将 cargo-deps-readme 添加到您的 crate 的 Cargo.toml 文件的 [dev-dependencies] 部分,通过添加以下行

[dev-dependencies]
cargo-deps-readme = "0.1.0"

运行以下命令以生成 README.md 文件

cargo deps-readme

这将创建一个名为 DEPENDECIES.md 的新文件,其中包含您 Cargo.toml 文件中指定的所有依赖项。

输出将是一个以下格式的格式化依赖项列表


- [crate-name](https://crates.io/crates/crate-name) - version: 0.1.0 - description: This crate does something useful
- [other-crate](https://crates.io/crates/other-crate) - version: 0.2.3 - description: Another useful crate

此 crate 对于希望为用户和贡献者提供易于访问的依赖项列表的 crate 作者很有用。它也可以由希望快速了解他们使用或贡献的 crate 的依赖项的开发者使用。

依赖项

~9–22MB
~346K SLoC