关于项目

该项目旨在通过帮助您快速生成一个外观良好的 README 来自动化部分编码工作流程。您回答问题，我们为您编写样板代码。

(返回顶部)

使用技术

• Clap
• Inquire
• Handlebars Rust
• 等等...

(返回顶部)

入门

本节将教您如何设置和运行程序

先决条件

目前，您需要在系统上安装 cargo 和 rust。

  curl https://sh.rustup.rs -sSf | sh 

最终，将提供非 cargo 安装方法。

安装

只需使用 cargo 安装应用程序即可。

  cargo install makereadme

(返回顶部)

使用方法

README.md 将在您的当前目录下创建。只需运行

makereadme

回答提示，您的 README.md 就准备好供您进行最终修改。

(返回顶部)

路线图

• 完整的测试覆盖
• 环境分析和自动完成
• 更好的性能和二进制大小
• 更好的错误处理
• 带有示例的文档
• 更多的模板选项和允许自定义

查看 开放问题 获取完整的功能列表（以及已知问题）。

(返回顶部)

贡献

贡献使开源社区成为一个如此美妙的学习、灵感和创造的地方。您做出的任何贡献都将被 高度赞赏。请参阅 行为准则 和 贡献指南 以获取更多信息。

(返回顶部)

许可协议

在 MIT 许可协议下发行。有关更多信息，请参阅 LICENSE。

(返回顶部)

致谢

• readme-md-generator
• Best-README-Template
• ReadME-Generator

(返回顶部)