1 - 前置条件
列出安装前需要准备的工具与权限。
前置条件应当简短、精确,而且可以验证。
工具
- 受支持的操作系统。
- 用于获取源码的 Git。
- 项目所需的运行时版本。
验证
为每个前置条件提供一条验证命令:
发布前请把占位命令换成你的真实命令。
2 - 安装
帮助新用户从源码走到可工作的结果。
首先给出最短且受支持的安装路径。
安装
确认结果
准确告诉读者成功是什么样子:要打开哪个网址、会看到什么消息,或者哪条命令应当返回零。
重要
发布项目文档前,请替换所有大写占位符。
前置条件应当简短、精确,而且可以验证。
为每个前置条件提供一条验证命令:
发布前请把占位命令换成你的真实命令。
首先给出最短且受支持的安装路径。
准确告诉读者成功是什么样子:要打开哪个网址、会看到什么消息,或者哪条命令应当返回零。
发布项目文档前,请替换所有大写占位符。