跳转到主要内容

这是本节的多页打印视图。 .

返回本页常规视图.

快速上手

检查前置条件并完成第一次安装。

从一台干净的机器开始,得到一个可以工作的本地结果。

1 - 前置条件

列出安装前需要准备的工具与权限。

前置条件应当简短、精确,而且可以验证。

工具

  • 受支持的操作系统。
  • 用于获取源码的 Git。
  • 项目所需的运行时版本。

验证

为每个前置条件提供一条验证命令:

$ project --version
project 0.1.0

发布前请把占位命令换成你的真实命令。

2 - 安装

帮助新用户从源码走到可工作的结果。

首先给出最短且受支持的安装路径。

安装

git clone https://github.com/OWNER/PROJECT.git
cd PROJECT
./project start

确认结果

准确告诉读者成功是什么样子:要打开哪个网址、会看到什么消息,或者哪条命令应当返回零。

重要

发布项目文档前,请替换所有大写占位符。