最后，不消再一个个地提醒同事读README了

nqkk58

前言

你是不是在参与有README.md的项目的编写时，老是在更改了README.md之后不厌其烦地一个一个通知同事去读README.md？你是不是遇到过有人由于没读README.md，在修改代码的时候犯了低级错误？你是不是在项目中有好几个乃至几十个README.md，而无办法在README.md被修改之后即时地找到并阅读README.md？

此刻好了，有了rtf-readme这个项目中的插件和关联CLI工具后，你再亦不消担心上面的问题了。

rtf-readme项目位置：https://github.com/digshare/rtf-readme

VSCode 插件位置： https://marketplace.visualstudio.com/items?itemName=enverse.vscode-rtf-readme

项目讨论QQ群：1029881641

rtf-readme项目功能一览

支持在VSCode中，当打开/修改一个文件时，提醒查看修改这个文件所必须读的README文件。支持在CI中，运用命令行来查看是不是有人 在无阅读必须读的README 的状况下，修改了某个文件。支持在README中，运用glob patterns来指定某些文件在修改时必须读这个README。支持README文件中写父目录路径的glob patterns。支持自定义必须提示查看的README的路径。

过一遍项目的插件功能

rtf-readme项目分为三个部分：VSCode插件、命令行客户端、命令行服务端。其中，木帆科技已然供给了一个服务端，在生成配置文件的时候会自动添加到配置文件中，因此运用这个项目的童鞋们不消自己去找公网服务器安排了。而要运用VSCode插件、命令行客户端，必要要在项目中有个配置文件。

下面，我们就来尝试用VSCode插件来创建一个rtf-readme项目所必须的配置文件。

首要，咱们必须下载vscode插件rtf-readme。在插件搜索框中输入rtf-readme，找到rtf-README插件，并下载。

下载完成后，按Ctrl+Shift+P快捷键，而后在弹出来的框中输入Create Config File，找到rtf-README插件所供给的命令“rtf-README: Create Config File”。

运用命令“rtf-README: Create Config File”来创建配置文件，通常server的URL直接运用默认的就好（除非你自己在某个公网服务器搭了个rtf-readme服务）。创建好的配置文件放在项目根目录里，

nqkk58

楼主的文章深得我心，表示由衷的感谢！