README 生成器

概述

使用这个轻量级的命令行工具，轻松生成 README.md 文件。虽然它包含几个默认模板，但其优势在于能够与您自己的自定义模板一起工作。

使用自定义模板

1. 在操作系统的 Documents 文件夹内创建一个名为 readme-templates 的目录（或使用 --template-dir 参数指定不同的目录）。

2. 将您的 Markdown 模板添加到该目录中。

3. 在每个模板的开头，通过添加一行如 占位符: [占位符名称_1],[占位符名称_2] 的内容来指定占位符。占位符之间不要有空格。

   例如：占位符: [项目名称],[作者名称]

使用此工具时，它将提示您输入每个占位符的值。然后，工具将替换文件中所有占位符的出现。

注意事项

• 占位符是可选的：您可以选择包含或不包含它们。
• 占位符列表中不要有空格：

如果您想查看一些示例，请查看模板文件夹。

提示：要使模板部分可选，只需在标题前加上 ?。例如，## ?贡献 表示可选的 "贡献" 部分。

安装

使用 cargo

cargo install generate-readme

从源代码

git clone https://github.com/jacobschwantes/generate-readme.git
cd generate-readme
cargo install --path .

使用方法

generate-readme

# To use a path to custom templates other than the default ~/Documents/readme-templates
generate-readme --template-dir path/to/custom/templates

贡献

Fork 仓库

git checkout -b fix/amazingFix

提交更改并将它们推送到您的分支

git commit -m "made an amazingFix"
git push origin fix/amazingFix

打开一个 pull request