48 lines
680 B
Markdown
48 lines
680 B
Markdown
|
<!--
|
|||
|
|
模块：quickstart（快速开始）
|
|||
|
|
用途：让用户在 5 分钟内体验核心功能
|
|||
|
|
位置：通常放在安装之后
|
|||
|
|
-->
|
|||
|
|
|
|||
|
|
## 快速开始
|
|||
|
|
|
|||
|
|
只需 3 步，即可体验 {{PROJECT_NAME}} 的核心功能：
|
|||
|
|
|
|||
|
|
### 1. 安装
|
|||
|
|
|
|||
|
|
```bash
|
|||
|
|
{{INSTALL_COMMAND}}
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### 2. 初始化
|
|||
|
|
|
|||
|
|
```bash
|
|||
|
|
{{INIT_COMMAND}}
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### 3. 运行
|
|||
|
|
|
|||
|
|
```bash
|
|||
|
|
{{RUN_COMMAND}}
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
**预期输出**：
|
|||
|
|
|
|||
|
|
```
|
|||
|
|
{{EXPECTED_OUTPUT}}
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### 下一步
|
|||
|
|
|
|||
|
|
- [完整使用指南](#使用说明)
|
|||
|
|
- [配置选项](#配置)
|
|||
|
|
- [更多示例](#示例)
|
|||
|
|
|
|||
|
|
<!--
|
|||
|
|
编写提示：
|
|||
|
|
- 保持步骤简洁，最多 3-5 步
|
|||
|
|
- 每步都应有可执行的命令
|
|||
|
|
- 包含预期输出帮助用户验证
|
|||
|
|
- 链接到更详细的文档
|
|||
|
|
-->
|