如何写出别人真正能照着操作的 README

README 应帮助新读者迈出第一步有用的行动。他们判断项目做什么、是否与自己有关之前，不需要先理解每个实现细节。

先说明结果

描述项目做什么、面向谁，以及重要限制。具体例子比形容词列表更有用。如果有助于解释用途，在靠近顶部的位置放置展示实际效果的截图或示例结果。

接着说明前提条件：操作系统、运行时版本和必要服务。区分可选集成与启动所必需的内容。不要让读者安装到一半才发现关键要求。

按必须发生的顺序写设置步骤。解释命令应在哪里运行，以及成功结果是什么样。清楚标示占位配置，绝不要在示例中包含真实凭据。

从全新检出或同等起点测试说明。某条命令如果只有因为你的电脑装了未记录工具才能运行，就是文档缺漏。把可选变体放在最简单的受支持路径之后。

添加运行、检查和更新项目的常用命令。链接更深入的文档，不必把每个专业主题都放在开头。包含官方支持的问题反馈位置，并在相关时注明许可证。

用 MeatPad 在项目文件旁编辑 README，再在目标位置检查渲染后的 Markdown。点击链接，按仓库实际路径检查图片。设置改变时，在同一次修改中更新 README，让首次运行说明描述人们实际收到的版本。

从一条笔记开始。MeatPad 为笔记、Markdown 和项目文件提供 Mac 上的本地工作区，无须账户。