# README 模板（编号章节版）

> 用法：按下面骨架填内容；`<...>` 是占位符。所有相对路径写仓库内路径，图片统一放 `assets/readme/`。
> 结构可以按项目类型加减章节，但**编号必须连续**，`readme_lint` 会检查。

```markdown
<p align="center">
  <img src="./assets/readme/banner.png" width="100%" alt="<项目名> —— <一句话说明>">
</p>

<div align="center">

[![DSH](https://img.shields.io/badge/DSH-<实测版本>-4D6BFE?style=flat-square&logo=deepseek&logoColor=white)](https://github.com/deepseek-ai/deepseek-harness)
[![<特性标签>](https://img.shields.io/badge/<URL编码>-<颜色HEX>?style=flat-square)]()
[![License](https://img.shields.io/badge/License-MIT-yellow?style=flat-square&logo=opensourceinitiative&logoColor=white)](./LICENSE)

</div>

---

## 1. 它是什么

<两句话讲清楚：给谁用、解决什么问题。>

<再用 3–5 条 bullet 说具体差异，每条带一个可验证的点（数字 / 接口 / 文件 / 行为），不要只写形容词。>

## 2. 效果预览（可选）

| <产物 A> | <产物 B> |
|---|---|
| ![<说明>](./docs/<示例图>.png) | ![<说明>](./docs/<示例图>.png) |

<说明示例图的来源；数字与专名以原视频/原始数据为准。>

## 3. 过程 / 工作原理

![过程图](./assets/readme/flow.png)

1. **<步骤名>**：<做什么、调什么接口/脚本、产出什么>。
2. **<步骤名>**：…
3. **<步骤名>**：…

产出：

| 产物 | 说明 |
|---|---|
| `<文件>` | <内容与用途> |

## 4. 快速开始

### 4.1 前置条件

- <系统 / 运行时 / 版本要求，写实测值>
- <磁盘 / 网络 / 账号要求>
- <不需要什么（避免用户误会）>

### 4.2 安装

```bash
git clone <仓库地址>
```

1. <复制到哪、目录名要求>
2. <配置文件改哪一行，贴出片段>

   ```yaml
   <片段>
   ```

3. **重启 <宿主程序>**，<说明为什么必须重启>。

### 4.3 验证

<怎么确认装好了：发什么、看到什么。>

## 5. 工具 / 命令说明

| 工具 / 命令 | 做什么 | 关键参数 |
|---|---|---|
| `<名字>` | <一句话> | `<参数>`（必填/可选） |

## 6. 配置与目录

| 变量 / 配置 | 默认值 | 作用 |
|---|---|---|
| `<变量>` | `<默认>` | <说明> |

```text
<仓库名>/
├── <文件>        # <作用>
└── <目录>/       # <作用>
```

## 7. 设计取舍

<为什么这么做、踩过什么坑；每条写「问题 → 根因 → 现在的做法」，能引到 references 就引。>

## 8. 手动排查 / 本地开发

```bash
<可直接复制的命令>
```

## 9. 卸载与回滚

<删什么、重启什么、数据要不要留。>

## 10. 常见问题

**<问题>？** <一句话答案。>

## 11. License

[MIT](./LICENSE) © <年份> <作者>
```

## 检查清单（推送前）

- [ ] 首图 banner 存在且首屏可见（`assets/readme/banner.png`）
- [ ] 过程图存在（长流程/多步骤的项目必须有）
- [ ] 章节编号从 1 连续到 N
- [ ] 表格都有 `|---|` 分隔行
- [ ] 图片、相对链接目标都真实存在
- [ ] 版本号 / 命令 / 路径和代码一致，没有编造
- [ ] 文案过了 `deai_audit`（report 或 article 文体），总分压到 25 以下