Readme.md中生成项目目录结构

需求:当编写项目文档时,需要在 README.md 中对项目整体的目录结构以及文件的功能进行说明。

1、安装HomeBrew

参考:Mac安装HomeBrew&HomeBrew安装yarn_梦魇米莉的博客-CSDN博客

2、使用HomeBrew安装tree

brew install tree

3、使用 tree 在控制台生产当前目录树

// 因为实例项目为 js 项目,所以忽略了 node_modules,可根据真实项目选择性忽略文件目录,防止文件树过长
tree -I node_modules > tree.text

4、复制目录树文本到 README.md 中

执行上一步会生成一个tree.text文件,打开复制其中的内容

 

相关文章

最近做自动化测试时,深感自己对前端涉猎太少,加上对这块比...
homebrew本身就是一个git仓库。使用homebrew安装软件包时,会...
一、Homebrew安装、卸载等命令Homebrew的安装和卸载都非常简...
在mac系统中,使用homebrew可以很方便的管理包。按照官网的说...
我按照说明从这里使用brew安装mysqlhttps://gist.github.com...
我在macOS10.12.4上安装了nginx1.10.3和php5.5.38作为开发服...