简介
verb-generate-readme 是一个 npm 包，它可以帮助你生成 README.md 文件。README.md 是一个项目的重要文件，它能够展示项目的功能、用法、贡献者等信息。然而，很多时候编写 README.md 可能比编写代码还要困难，特别是对于那些不擅长写作的开发者来说。
verb-generate-readme 可以使用模板语言和 Markdown 语法，根据项目的 metadata 和 package.json 文件生成 README.md 文件，从而快速构建一个漂亮且有用的 README.md 文件。
安装
在终端中输入以下命令来安装 verb-generate-readme：
npm install -g verb-generate-readme
使用
添加 metadata 到 package.json
在使用 verb-generate-readme 之前，我们需要在项目的 package.json 文件中添加一些 metadata。metadata 是一些描述项目的属性，包括项目名称、描述、版本号、作者、许可证等。这些信息将被用来填充 README.md 模板。
{
"name": "my-project",
"version": "0.1.0",
"description": "My amazing project",
"author": "Your Name",
"license": "MIT"
}编写 README.md 模板
下面是一个简单的 README.md 模板示例：
-- -------------------- ---- ------- - --- ---- -- --- ----------- -- -- -- -- --- - ---- --- ----- --- -------
或者
yarn install
用法
<%= usage %>
贡献者
感谢以下贡献者的支持：
<%= contributors %>
许可证
<%= license %> 许可证。
在模板中，我们可以使用 `<%= %>` 标记来插入 metadata。例如，`<%= name %>` 将会被替换为 package.json 中的项目名称。 ### 运行 verb-generate-readme 完成模板后，我们可以使用 verb-generate-readme 来生成 README.md 文件了。在终端中进入项目目录并输入以下命令：
verb-generate-readme
如果一切顺利，你将会看到类似下面这样的输出：
using template: /Users/username/project/template.md writing README.md
-- -------------------- ---- ------- ------------ --------- -- - --------- ---- --------------------- --------- ---------------- --------- ---------- -------------------- --- ----------- ------------ -------------------------- --------- -- -- - --------- ----------
2. 在运行 verb-generate-readme 命令时添加 `--section=faq` 选项：
verb-generate-readme --section=faq
-- -------------------- ---- ------- ---- --------- ---------------------------- -- -- -------------------- ---------------------------- --------- ------------------------- -------------------- -------- - ----------------------------------------------------------- -------- ----------------------------------------------------------------------------------