[toc]

ReadMe

readme 是一个自动生成 [[【Linux】readme|readme]] 的工具

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

开源项目作者：Franck Abgrall

用法

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:

bash

npx readme-md-generator

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

bash

npx readme-md-generator -y

Use your own ejs README template (-p):

bash

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

You can find ejs README template examples here.、

bash

readme

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

bash

readme -y

Use your own ejs README template (-p):

bash

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