nqkk58 发表于 2024-6-29 19:45:11

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


    <h3 style="color: black; text-align: left; margin-bottom: 10px;">前言</h3>
    <p style="font-size: 16px; color: black; line-height: 40px; text-align: left; margin-bottom: 15px;">你<span style="color: black;">是不是</span>在参与有README.md的项目的编写时,老是在更改了README.md之后不厌其烦地一个一个<span style="color: black;">通知</span>同事去读README.md?你<span style="color: black;">是不是</span>遇到过有人<span style="color: black;">由于</span>没读README.md,在修改代码的时候犯了低级错误?你<span style="color: black;">是不是</span>在项目中有好几个<span style="color: black;">乃至</span>几十个README.md,而<span style="color: black;">无</span>办法在README.md被修改之后<span style="color: black;">即时</span>地找到并阅读README.md?</p>
    <p style="font-size: 16px; color: black; line-height: 40px; text-align: left; margin-bottom: 15px;"><span style="color: black;">此刻</span>好了,有了rtf-readme这个项目中的插件和<span style="color: black;">关联</span>CLI<span style="color: black;">工具</span>后,你再<span style="color: black;">亦</span><span style="color: black;">不消</span>担心上面的问题了。</p>
    <p style="font-size: 16px; color: black; line-height: 40px; text-align: left; margin-bottom: 15px;">rtf-readme项目<span style="color: black;">位置</span>:<a style="color: black;"><span style="color: black;">https://</span><span style="color: black;">github.com/digshare/rtf</span><span style="color: black;">-readme</span></a></p>
    <p style="font-size: 16px; color: black; line-height: 40px; text-align: left; margin-bottom: 15px;">VSCode 插件<span style="color: black;">位置</span>: <a style="color: black;"><span style="color: black;">https://</span><span style="color: black;">marketpla</span></a>ce.visualstudio.com<span style="color: black;">/items?itemName=enverse.vscode-rtf-readme</span></p>
    <p style="font-size: 16px; color: black; line-height: 40px; text-align: left; margin-bottom: 15px;">项目讨论QQ群:1029881641</p>
    <h3 style="color: black; text-align: left; margin-bottom: 10px;">rtf-readme项目功能一览</h3>支持在VSCode中,当打开/修改一个文件时,提醒查看修改这个文件所<span style="color: black;">必须</span>读的README文件。支持在CI中,<span style="color: black;">运用</span>命令行来查看<span style="color: black;">是不是</span>有人 在<span style="color: black;">无</span>阅读<span style="color: black;">必须</span>读的README 的<span style="color: black;">状况</span>下,修改了某个文件。支持在README中,<span style="color: black;">运用</span>glob patterns来指定某些文件在修改时<span style="color: black;">必须</span>读这个README。支持README文件中写父目录路径的glob patterns。支持自定义<span style="color: black;">必须</span>提示查看的README的路径。<h3 style="color: black; text-align: left; margin-bottom: 10px;">过一遍项目的插件功能</h3>
    <p style="font-size: 16px; color: black; line-height: 40px; text-align: left; margin-bottom: 15px;">rtf-readme项目分为三个部分:VSCode插件、命令行客户端、命令行服务端。其中,木帆科技<span style="color: black;">已然</span><span style="color: black;">供给</span>了一个服务端,在生成配置文件的时候会自动添加到配置文件中,<span style="color: black;">因此</span><span style="color: black;">运用</span>这个项目的童鞋们<span style="color: black;">不消</span>自己去找公网服务器<span style="color: black;">安排</span>了。而要<span style="color: black;">运用</span>VSCode插件、命令行客户端,<span style="color: black;">必要</span>要在项目中有个配置文件。</p>
    <p style="font-size: 16px; color: black; line-height: 40px; text-align: left; margin-bottom: 15px;">下面,我们就来尝试用VSCode插件来创建一个rtf-readme项目所<span style="color: black;">必须</span>的配置文件。</p>
    <p style="font-size: 16px; color: black; line-height: 40px; text-align: left; margin-bottom: 15px;"><span style="color: black;">首要</span>,<span style="color: black;">咱们</span><span style="color: black;">必须</span>下载vscode插件rtf-readme。在插件搜索框中输入rtf-readme,找到rtf-README插件,并下载。</p>
    <div style="color: black; text-align: left; margin-bottom: 10px;"><img src="https://pic4.zhimg.com/80/v2-d2b98ea72adce0917af4aa7fea32dfdb_720w.webp" style="width: 50%; margin-bottom: 20px;"></div>
    <p style="font-size: 16px; color: black; line-height: 40px; text-align: left; margin-bottom: 15px;">下载完成后,按Ctrl+Shift+P快捷键,<span style="color: black;">而后</span>在弹出来的框中输入Create Config File,找到rtf-README插件所<span style="color: black;">供给</span>的命令“rtf-README: Create Config File”。</p>
    <div style="color: black; text-align: left; margin-bottom: 10px;"><img src="https://pic4.zhimg.com/80/v2-7519a6e3c6bdb9902fd796926ddfb2e7_720w.webp" style="width: 50%; margin-bottom: 20px;"></div>
    <p style="font-size: 16px; color: black; line-height: 40px; text-align: left; margin-bottom: 15px;"><span style="color: black;">运用</span>命令“rtf-README: Create Config File”来创建配置文件,<span style="color: black;">通常</span>server的URL直接<span style="color: black;">运用</span>默认的就好(除非你自己在某个公网服务器搭了个rtf-readme服务)。创建好的配置文件放在项目根目录里,</p>




nqkk58 发表于 3 天前

楼主的文章深得我心,表示由衷的感谢!
页: [1]
查看完整版本: 最后,不消再一个个地提醒同事读README了