read readme:如果README不可读则其他任何内容都不会。 适用于使用GitHub Actions构建的自述文件的linterproofread CI

可读的自述文件 如果自述文件不可读,则没有其他内容。 我们常常发现一个很棒的项目,但是在5分钟后放弃是因为我们无法从README获得足够的信息。 我不会责怪开发人员糟糕的README可读性,因为,首先,与代码不同,从来没有关注README可读性,其次,没有很好的工具来实现README可读性。 readable-readme项目旨在构建一个GitHub操作,该操作检查README文件的可读性并生成报告以帮助改进它。 入门 将以下代码添加到您的工作流步骤中: - uses : actions/checkout@v1 - name : Readable Readme uses : tia