title: Readme 工具使用手册
categories:
  - 手册

• ReadMe
• 用法
  • npx 用法
  • Windows 系统使用

ReadMe

readme 是一个自动生成 readme 的工具

开源项目地址：https://github.com/kefranabg/readme-md-generator

开源项目作者：Franck Abgrall

用法

npx 用法

Make sure you have npx installed (npx is shipped by default since npm 5.2.0)

Just run the following command at the root of your project and answer questions:

npx readme-md-generator

Or use default values for all questions (-y):

npx readme-md-generator -y

Use your own ejs README template (-p):

npx readme-md-generator -p path/to/my/own/template.md

You can find ejs README template examples here.、

Windows 系统使用

readme

Or use default values for all questions (-y):

readme -y

Use your own ejs README template (-p):

readme -p D:my/own/template.md