93d1b21的任务收尾
This commit is contained in:
@@ -0,0 +1,89 @@
|
||||
<!--
|
||||
模块：api（API 文档）
|
||||
用途：详细的接口说明
|
||||
位置：库项目的核心章节
|
||||
-->
|
||||
|
||||
## API 文档
|
||||
|
||||
### 概览
|
||||
|
||||
{{API_OVERVIEW}}
|
||||
|
||||
### 核心 API
|
||||
|
||||
#### `{{FUNCTION_1_NAME}}`
|
||||
|
||||
{{FUNCTION_1_DESCRIPTION}}
|
||||
|
||||
**签名**：
|
||||
|
||||
```{{LANGUAGE}}
|
||||
{{FUNCTION_1_SIGNATURE}}
|
||||
```
|
||||
|
||||
**参数**：
|
||||
|
||||
| 参数 | 类型 | 必需 | 说明 |
|
||||
|------|------|------|------|
|
||||
{{FUNCTION_1_PARAMS}}
|
||||
|
||||
**返回值**：
|
||||
|
||||
{{FUNCTION_1_RETURN}}
|
||||
|
||||
**示例**：
|
||||
|
||||
```{{LANGUAGE}}
|
||||
{{FUNCTION_1_EXAMPLE}}
|
||||
```
|
||||
|
||||
#### `{{FUNCTION_2_NAME}}`
|
||||
|
||||
{{FUNCTION_2_DESCRIPTION}}
|
||||
|
||||
**签名**：
|
||||
|
||||
```{{LANGUAGE}}
|
||||
{{FUNCTION_2_SIGNATURE}}
|
||||
```
|
||||
|
||||
**参数**：
|
||||
|
||||
| 参数 | 类型 | 必需 | 说明 |
|
||||
|------|------|------|------|
|
||||
{{FUNCTION_2_PARAMS}}
|
||||
|
||||
**返回值**：
|
||||
|
||||
{{FUNCTION_2_RETURN}}
|
||||
|
||||
### 类型定义
|
||||
|
||||
```{{LANGUAGE}}
|
||||
{{TYPE_DEFINITIONS}}
|
||||
```
|
||||
|
||||
### 常量
|
||||
|
||||
| 常量 | 值 | 说明 |
|
||||
|------|-----|------|
|
||||
{{CONSTANTS_TABLE}}
|
||||
|
||||
### 错误处理
|
||||
|
||||
| 错误码 | 说明 | 处理建议 |
|
||||
|--------|------|----------|
|
||||
{{ERRORS_TABLE}}
|
||||
|
||||
### 完整 API 参考
|
||||
|
||||
详细的 API 文档请查看 [API Reference]({{API_REFERENCE_URL}})。
|
||||
|
||||
<!--
|
||||
编写提示：
|
||||
- 每个函数都有签名、参数、返回值、示例
|
||||
- 类型定义要完整
|
||||
- 说明错误处理方式
|
||||
- 保持格式统一
|
||||
-->
|
||||
@@ -0,0 +1,77 @@
|
||||
<!--
|
||||
模块：architecture（架构概述）
|
||||
用途：说明系统架构和设计
|
||||
位置：复杂项目的重要章节
|
||||
-->
|
||||
|
||||
## 架构
|
||||
|
||||
### 系统概览
|
||||
|
||||
{{SYSTEM_OVERVIEW}}
|
||||
|
||||
### 架构图
|
||||
|
||||
```
|
||||
{{ARCHITECTURE_DIAGRAM}}
|
||||
```
|
||||
|
||||
### 核心组件
|
||||
|
||||
| 组件 | 职责 | 技术 |
|
||||
|------|------|------|
|
||||
{{COMPONENTS_TABLE}}
|
||||
|
||||
### 数据流
|
||||
|
||||
```
|
||||
{{DATA_FLOW_DIAGRAM}}
|
||||
```
|
||||
|
||||
### 目录结构
|
||||
|
||||
```
|
||||
{{DIRECTORY_STRUCTURE}}
|
||||
```
|
||||
|
||||
### 模块说明
|
||||
|
||||
#### {{MODULE_1_NAME}}
|
||||
|
||||
- **职责**：{{MODULE_1_RESPONSIBILITY}}
|
||||
- **位置**：`{{MODULE_1_PATH}}`
|
||||
- **依赖**：{{MODULE_1_DEPENDENCIES}}
|
||||
|
||||
#### {{MODULE_2_NAME}}
|
||||
|
||||
- **职责**：{{MODULE_2_RESPONSIBILITY}}
|
||||
- **位置**：`{{MODULE_2_PATH}}`
|
||||
- **依赖**：{{MODULE_2_DEPENDENCIES}}
|
||||
|
||||
### 技术选型
|
||||
|
||||
| 领域 | 选择 | 原因 |
|
||||
|------|------|------|
|
||||
{{TECH_CHOICES_TABLE}}
|
||||
|
||||
### 设计决策
|
||||
|
||||
#### {{DECISION_1_TITLE}}
|
||||
|
||||
**背景**：{{DECISION_1_CONTEXT}}
|
||||
|
||||
**方案**：{{DECISION_1_SOLUTION}}
|
||||
|
||||
**权衡**：{{DECISION_1_TRADEOFFS}}
|
||||
|
||||
### 扩展点
|
||||
|
||||
{{EXTENSION_POINTS}}
|
||||
|
||||
<!--
|
||||
编写提示：
|
||||
- 图文结合说明架构
|
||||
- 清晰说明各组件职责
|
||||
- 记录重要设计决策
|
||||
- 说明扩展方式
|
||||
-->
|
||||
@@ -0,0 +1,71 @@
|
||||
<!--
|
||||
模块：changelog（变更日志）
|
||||
用途：版本历史和变更记录
|
||||
位置：通常作为独立文件或 README 章节
|
||||
-->
|
||||
|
||||
## 变更日志
|
||||
|
||||
所有重要的变更都会记录在此文件中。
|
||||
|
||||
格式基于 [Keep a Changelog](https://keepachangelog.com/)，
|
||||
版本号遵循 [语义化版本](https://semver.org/)。
|
||||
|
||||
### [Unreleased]
|
||||
|
||||
#### 新增
|
||||
- {{UNRELEASED_ADDED}}
|
||||
|
||||
#### 变更
|
||||
- {{UNRELEASED_CHANGED}}
|
||||
|
||||
#### 修复
|
||||
- {{UNRELEASED_FIXED}}
|
||||
|
||||
---
|
||||
|
||||
### [{{VERSION_1}}] - {{DATE_1}}
|
||||
|
||||
#### 新增
|
||||
- {{V1_ADDED_1}}
|
||||
- {{V1_ADDED_2}}
|
||||
|
||||
#### 变更
|
||||
- {{V1_CHANGED_1}}
|
||||
|
||||
#### 修复
|
||||
- {{V1_FIXED_1}}
|
||||
|
||||
#### 移除
|
||||
- {{V1_REMOVED_1}}
|
||||
|
||||
---
|
||||
|
||||
### [{{VERSION_2}}] - {{DATE_2}}
|
||||
|
||||
#### 新增
|
||||
- {{V2_ADDED_1}}
|
||||
|
||||
#### 修复
|
||||
- {{V2_FIXED_1}}
|
||||
|
||||
---
|
||||
|
||||
### [{{VERSION_INITIAL}}] - {{DATE_INITIAL}}
|
||||
|
||||
- 首次发布
|
||||
|
||||
---
|
||||
|
||||
[Unreleased]: {{COMPARE_UNRELEASED_URL}}
|
||||
[{{VERSION_1}}]: {{COMPARE_V1_URL}}
|
||||
[{{VERSION_2}}]: {{COMPARE_V2_URL}}
|
||||
[{{VERSION_INITIAL}}]: {{TAG_INITIAL_URL}}
|
||||
|
||||
<!--
|
||||
编写提示：
|
||||
- 按版本倒序排列
|
||||
- 每个版本包含：新增、变更、修复、移除
|
||||
- 提供版本对比链接
|
||||
- 保持格式一致
|
||||
-->
|
||||
@@ -0,0 +1,85 @@
|
||||
<!--
|
||||
模块：configuration（配置说明）
|
||||
用途：详细的配置项说明
|
||||
位置：安装/使用之后
|
||||
-->
|
||||
|
||||
## 配置
|
||||
|
||||
### 配置文件
|
||||
|
||||
配置文件位置：`{{CONFIG_PATH}}`
|
||||
|
||||
首次运行会自动生成默认配置。
|
||||
|
||||
### 配置方式
|
||||
|
||||
#### 1. 配置文件
|
||||
|
||||
编辑 `{{CONFIG_FILE}}`：
|
||||
|
||||
```{{CONFIG_FORMAT}}
|
||||
{{CONFIG_EXAMPLE}}
|
||||
```
|
||||
|
||||
#### 2. 环境变量
|
||||
|
||||
```bash
|
||||
{{ENV_VARS_EXAMPLE}}
|
||||
```
|
||||
|
||||
#### 3. 命令行参数
|
||||
|
||||
```bash
|
||||
{{CLI_ARGS_EXAMPLE}}
|
||||
```
|
||||
|
||||
**优先级**：命令行参数 > 环境变量 > 配置文件
|
||||
|
||||
### 配置项详解
|
||||
|
||||
#### `{{CONFIG_SECTION_1}}`
|
||||
|
||||
| 配置项 | 类型 | 默认值 | 说明 |
|
||||
|--------|------|--------|------|
|
||||
{{CONFIG_SECTION_1_TABLE}}
|
||||
|
||||
#### `{{CONFIG_SECTION_2}}`
|
||||
|
||||
| 配置项 | 类型 | 默认值 | 说明 |
|
||||
|--------|------|--------|------|
|
||||
{{CONFIG_SECTION_2_TABLE}}
|
||||
|
||||
### 完整配置示例
|
||||
|
||||
```{{CONFIG_FORMAT}}
|
||||
{{FULL_CONFIG_EXAMPLE}}
|
||||
```
|
||||
|
||||
### 配置验证
|
||||
|
||||
```bash
|
||||
{{VALIDATE_CONFIG_COMMAND}}
|
||||
```
|
||||
|
||||
### 常见配置场景
|
||||
|
||||
#### 场景 1：{{SCENARIO_1_NAME}}
|
||||
|
||||
```{{CONFIG_FORMAT}}
|
||||
{{SCENARIO_1_CONFIG}}
|
||||
```
|
||||
|
||||
#### 场景 2：{{SCENARIO_2_NAME}}
|
||||
|
||||
```{{CONFIG_FORMAT}}
|
||||
{{SCENARIO_2_CONFIG}}
|
||||
```
|
||||
|
||||
<!--
|
||||
编写提示：
|
||||
- 说明所有配置方式
|
||||
- 每个配置项有类型、默认值、说明
|
||||
- 提供实际场景配置示例
|
||||
- 说明优先级和验证方法
|
||||
-->
|
||||
@@ -0,0 +1,95 @@
|
||||
<!--
|
||||
模块：contributing（贡献指南）
|
||||
用途：指导如何为项目做贡献
|
||||
位置：开源项目必备
|
||||
-->
|
||||
|
||||
## 贡献指南
|
||||
|
||||
感谢你考虑为 {{PROJECT_NAME}} 做贡献！
|
||||
|
||||
### 贡献方式
|
||||
|
||||
- 报告 Bug
|
||||
- 提交功能建议
|
||||
- 改进文档
|
||||
- 提交代码 PR
|
||||
|
||||
### 开发环境
|
||||
|
||||
#### 环境要求
|
||||
|
||||
{{DEV_REQUIREMENTS}}
|
||||
|
||||
#### 环境搭建
|
||||
|
||||
```bash
|
||||
# 克隆仓库
|
||||
git clone {{REPO_URL}}
|
||||
cd {{PROJECT_DIR}}
|
||||
|
||||
# 安装依赖
|
||||
{{INSTALL_DEPS}}
|
||||
|
||||
# 运行测试
|
||||
{{RUN_TESTS}}
|
||||
```
|
||||
|
||||
### 代码规范
|
||||
|
||||
{{CODE_STYLE}}
|
||||
|
||||
#### 提交信息格式
|
||||
|
||||
```
|
||||
<type>(<scope>): <subject>
|
||||
|
||||
<body>
|
||||
|
||||
<footer>
|
||||
```
|
||||
|
||||
**type 类型**：
|
||||
- `feat`: 新功能
|
||||
- `fix`: 修复 Bug
|
||||
- `docs`: 文档更新
|
||||
- `style`: 代码格式
|
||||
- `refactor`: 重构
|
||||
- `test`: 测试相关
|
||||
- `chore`: 构建/工具
|
||||
|
||||
### 提交 PR
|
||||
|
||||
1. Fork 本仓库
|
||||
2. 创建特性分支：`git checkout -b feature/your-feature`
|
||||
3. 提交更改：`git commit -m 'feat: add some feature'`
|
||||
4. 推送分支：`git push origin feature/your-feature`
|
||||
5. 创建 Pull Request
|
||||
|
||||
### PR 检查清单
|
||||
|
||||
- [ ] 代码通过所有测试
|
||||
- [ ] 新功能有对应测试
|
||||
- [ ] 更新了相关文档
|
||||
- [ ] 提交信息格式正确
|
||||
|
||||
### 代码审查
|
||||
|
||||
所有 PR 都需要至少一位维护者审查后才能合并。
|
||||
|
||||
### 行为准则
|
||||
|
||||
请阅读并遵守我们的 [行为准则](CODE_OF_CONDUCT.md)。
|
||||
|
||||
### 联系方式
|
||||
|
||||
- 问题讨论：[GitHub Discussions]({{DISCUSSIONS_URL}})
|
||||
- Bug 报告：[GitHub Issues]({{ISSUES_URL}})
|
||||
|
||||
<!--
|
||||
编写提示：
|
||||
- 清晰说明贡献流程
|
||||
- 提供开发环境搭建指南
|
||||
- 说明代码规范
|
||||
- 包含 PR 检查清单
|
||||
-->
|
||||
@@ -0,0 +1,71 @@
|
||||
<!--
|
||||
模块：examples（使用示例）
|
||||
用途：展示典型用例和代码示例
|
||||
位置：通常放在基本用法之后
|
||||
-->
|
||||
|
||||
## 示例
|
||||
|
||||
### 基础示例
|
||||
|
||||
#### {{EXAMPLE_1_NAME}}
|
||||
|
||||
{{EXAMPLE_1_DESCRIPTION}}
|
||||
|
||||
```{{LANGUAGE}}
|
||||
{{EXAMPLE_1_CODE}}
|
||||
```
|
||||
|
||||
输出：
|
||||
|
||||
```
|
||||
{{EXAMPLE_1_OUTPUT}}
|
||||
```
|
||||
|
||||
#### {{EXAMPLE_2_NAME}}
|
||||
|
||||
{{EXAMPLE_2_DESCRIPTION}}
|
||||
|
||||
```{{LANGUAGE}}
|
||||
{{EXAMPLE_2_CODE}}
|
||||
```
|
||||
|
||||
### 进阶示例
|
||||
|
||||
#### {{ADVANCED_EXAMPLE_NAME}}
|
||||
|
||||
{{ADVANCED_EXAMPLE_DESCRIPTION}}
|
||||
|
||||
```{{LANGUAGE}}
|
||||
{{ADVANCED_EXAMPLE_CODE}}
|
||||
```
|
||||
|
||||
### 实际场景
|
||||
|
||||
#### 场景：{{SCENARIO_NAME}}
|
||||
|
||||
**需求**：{{SCENARIO_REQUIREMENT}}
|
||||
|
||||
**解决方案**：
|
||||
|
||||
```{{LANGUAGE}}
|
||||
{{SCENARIO_CODE}}
|
||||
```
|
||||
|
||||
**说明**：{{SCENARIO_EXPLANATION}}
|
||||
|
||||
### 完整示例项目
|
||||
|
||||
查看 [examples/](examples/) 目录获取完整的示例项目：
|
||||
|
||||
| 示例 | 说明 | 难度 |
|
||||
|------|------|------|
|
||||
{{EXAMPLES_TABLE}}
|
||||
|
||||
<!--
|
||||
编写提示：
|
||||
- 从简单到复杂递进
|
||||
- 示例代码可直接运行
|
||||
- 包含输出帮助理解
|
||||
- 解释关键代码逻辑
|
||||
-->
|
||||
@@ -0,0 +1,85 @@
|
||||
<!--
|
||||
模块：faq（常见问题）
|
||||
用途：解答用户常见问题
|
||||
位置：文档末尾或独立页面
|
||||
-->
|
||||
|
||||
## 常见问题
|
||||
|
||||
### 一般问题
|
||||
|
||||
#### Q: {{GENERAL_Q1}}
|
||||
|
||||
**A**: {{GENERAL_A1}}
|
||||
|
||||
#### Q: {{GENERAL_Q2}}
|
||||
|
||||
**A**: {{GENERAL_A2}}
|
||||
|
||||
### 安装问题
|
||||
|
||||
#### Q: {{INSTALL_Q1}}
|
||||
|
||||
**A**: {{INSTALL_A1}}
|
||||
|
||||
```bash
|
||||
{{INSTALL_SOLUTION_1}}
|
||||
```
|
||||
|
||||
#### Q: {{INSTALL_Q2}}
|
||||
|
||||
**A**: {{INSTALL_A2}}
|
||||
|
||||
### 使用问题
|
||||
|
||||
#### Q: {{USAGE_Q1}}
|
||||
|
||||
**A**: {{USAGE_A1}}
|
||||
|
||||
示例：
|
||||
|
||||
```{{LANGUAGE}}
|
||||
{{USAGE_EXAMPLE_1}}
|
||||
```
|
||||
|
||||
#### Q: {{USAGE_Q2}}
|
||||
|
||||
**A**: {{USAGE_A2}}
|
||||
|
||||
### 故障排除
|
||||
|
||||
#### Q: {{TROUBLE_Q1}}
|
||||
|
||||
**A**: {{TROUBLE_A1}}
|
||||
|
||||
排查步骤：
|
||||
|
||||
1. {{TROUBLE_STEP_1}}
|
||||
2. {{TROUBLE_STEP_2}}
|
||||
3. {{TROUBLE_STEP_3}}
|
||||
|
||||
#### Q: {{TROUBLE_Q2}}
|
||||
|
||||
**A**: {{TROUBLE_A2}}
|
||||
|
||||
### 性能问题
|
||||
|
||||
#### Q: {{PERF_Q1}}
|
||||
|
||||
**A**: {{PERF_A1}}
|
||||
|
||||
### 其他问题
|
||||
|
||||
没有找到你的问题？
|
||||
|
||||
- 搜索 [Issues]({{ISSUES_URL}}) 看是否有人遇到过类似问题
|
||||
- 在 [Discussions]({{DISCUSSIONS_URL}}) 中提问
|
||||
- 提交新的 [Issue]({{NEW_ISSUE_URL}})
|
||||
|
||||
<!--
|
||||
编写提示：
|
||||
- 按类别组织问题
|
||||
- 问题简洁，答案详细
|
||||
- 包含代码示例和排查步骤
|
||||
- 提供进一步帮助的链接
|
||||
-->
|
||||
@@ -0,0 +1,88 @@
|
||||
<!--
|
||||
模块：installation（安装指南）
|
||||
用途：详细的多平台安装说明
|
||||
位置：通常放在功能特性之后
|
||||
-->
|
||||
|
||||
## 安装
|
||||
|
||||
### 系统要求
|
||||
|
||||
{{SYSTEM_REQUIREMENTS}}
|
||||
|
||||
### 方式一：包管理器（推荐）
|
||||
|
||||
#### macOS
|
||||
|
||||
```bash
|
||||
{{INSTALL_MACOS}}
|
||||
```
|
||||
|
||||
#### Linux
|
||||
|
||||
```bash
|
||||
{{INSTALL_LINUX}}
|
||||
```
|
||||
|
||||
#### Windows
|
||||
|
||||
```powershell
|
||||
{{INSTALL_WINDOWS}}
|
||||
```
|
||||
|
||||
### 方式二：预编译二进制
|
||||
|
||||
从 [Releases]({{RELEASES_URL}}) 下载对应平台的版本：
|
||||
|
||||
| 平台 | 架构 | 下载 |
|
||||
|------|------|------|
|
||||
| macOS | Intel/ARM | {{DOWNLOAD_MACOS}} |
|
||||
| Linux | x64/ARM | {{DOWNLOAD_LINUX}} |
|
||||
| Windows | x64 | {{DOWNLOAD_WINDOWS}} |
|
||||
|
||||
### 方式三：从源码构建
|
||||
|
||||
```bash
|
||||
# 克隆仓库
|
||||
git clone {{REPO_URL}}
|
||||
cd {{PROJECT_DIR}}
|
||||
|
||||
# 安装依赖
|
||||
{{INSTALL_DEPS}}
|
||||
|
||||
# 构建
|
||||
{{BUILD_COMMAND}}
|
||||
|
||||
# 安装到系统
|
||||
{{INSTALL_LOCAL}}
|
||||
```
|
||||
|
||||
### 验证安装
|
||||
|
||||
```bash
|
||||
{{VERIFY_COMMAND}}
|
||||
```
|
||||
|
||||
预期输出：
|
||||
|
||||
```
|
||||
{{VERIFY_OUTPUT}}
|
||||
```
|
||||
|
||||
### 常见问题
|
||||
|
||||
#### 问题 1：{{ISSUE_1}}
|
||||
|
||||
{{SOLUTION_1}}
|
||||
|
||||
#### 问题 2：{{ISSUE_2}}
|
||||
|
||||
{{SOLUTION_2}}
|
||||
|
||||
<!--
|
||||
编写提示：
|
||||
- 覆盖主流平台
|
||||
- 提供多种安装方式
|
||||
- 包含验证步骤
|
||||
- 列出常见安装问题
|
||||
-->
|
||||
@@ -0,0 +1,88 @@
|
||||
<!--
|
||||
模块：license（许可证）
|
||||
用途：说明项目许可证
|
||||
位置：README 末尾
|
||||
-->
|
||||
|
||||
## 许可证
|
||||
|
||||
本项目采用 {{LICENSE_NAME}} 许可证。
|
||||
|
||||
### 简要说明
|
||||
|
||||
{{LICENSE_SUMMARY}}
|
||||
|
||||
### 你可以
|
||||
|
||||
- {{CAN_1}}
|
||||
- {{CAN_2}}
|
||||
- {{CAN_3}}
|
||||
|
||||
### 你不可以
|
||||
|
||||
- {{CANNOT_1}}
|
||||
- {{CANNOT_2}}
|
||||
|
||||
### 你必须
|
||||
|
||||
- {{MUST_1}}
|
||||
- {{MUST_2}}
|
||||
|
||||
### 完整许可证
|
||||
|
||||
查看 [LICENSE](LICENSE) 文件获取完整许可证文本。
|
||||
|
||||
---
|
||||
|
||||
**常用许可证模板**：
|
||||
|
||||
#### MIT
|
||||
|
||||
```
|
||||
MIT License
|
||||
|
||||
Copyright (c) {{YEAR}} {{AUTHOR}}
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
```
|
||||
|
||||
#### Apache 2.0
|
||||
|
||||
```
|
||||
Copyright {{YEAR}} {{AUTHOR}}
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
```
|
||||
|
||||
<!--
|
||||
编写提示：
|
||||
- 选择合适的许可证
|
||||
- 简要说明权限和限制
|
||||
- 提供完整许可证链接
|
||||
-->
|
||||
@@ -0,0 +1,47 @@
|
||||
<!--
|
||||
模块：quickstart（快速开始）
|
||||
用途：让用户在 5 分钟内体验核心功能
|
||||
位置：通常放在安装之后
|
||||
-->
|
||||
|
||||
## 快速开始
|
||||
|
||||
只需 3 步，即可体验 {{PROJECT_NAME}} 的核心功能：
|
||||
|
||||
### 1. 安装
|
||||
|
||||
```bash
|
||||
{{INSTALL_COMMAND}}
|
||||
```
|
||||
|
||||
### 2. 初始化
|
||||
|
||||
```bash
|
||||
{{INIT_COMMAND}}
|
||||
```
|
||||
|
||||
### 3. 运行
|
||||
|
||||
```bash
|
||||
{{RUN_COMMAND}}
|
||||
```
|
||||
|
||||
**预期输出**：
|
||||
|
||||
```
|
||||
{{EXPECTED_OUTPUT}}
|
||||
```
|
||||
|
||||
### 下一步
|
||||
|
||||
- [完整使用指南](#使用说明)
|
||||
- [配置选项](#配置)
|
||||
- [更多示例](#示例)
|
||||
|
||||
<!--
|
||||
编写提示：
|
||||
- 保持步骤简洁，最多 3-5 步
|
||||
- 每步都应有可执行的命令
|
||||
- 包含预期输出帮助用户验证
|
||||
- 链接到更详细的文档
|
||||
-->
|
||||
Reference in New Issue
Block a user