案例 README 模板

{案例名称}

{一句话定位：实现什么功能、面向什么场景。}

功能特性：

{功能点 1}
{功能点 2}

-

目录结构

{案例名}/
├── CMakeLists.txt         # 编译入口
├── app.defconfig          # Kconfig 差异配置
├── source/                # 应用源码（可选，复杂案例使用子目录）
├── patch/                 # SDK 补丁（可选）
│   └── apply_patches.sh
├── rootfs/                # 文件系统配置（可选）
└── README.md

前提条件

{列出所需的固件、硬件模块等依赖}

硬件接线见附录 · 硬件方案

配置与依赖

WiFi / 外设驱动（如 WS73）：{默认用内置预编译驱动；内核配置变更时按 {方案} 重新编译}。
配置信息（如云端密钥 / config 文件）：参考 [{配置说明}]({子 README 相对路径}) 填写。

编译

{编译步骤。根据案例实际情况填写，包括依赖包获取、编译命令、可选编译参数等。}

构建参数

选项	取值	说明
`{-DXXX / CONFIG_XXX}`	`{值}`	{对应的变体 / 方案}

示例：

bash scripts/build.sh build --target {开发板} {APP_TYPE} {案例名} -D{选项}={值}

编译产物：

{镜像类写 _build/install/xxxx/xxxx/，可执行类写 _build/bin/{名}}

烧写

上板运行

{步骤1}
{步骤2}

退出应用

{退出方式与资源释放说明，如响应 Ctrl+C / SIGTERM。}

功能说明

{功能点 1}

{功能描述、操作方式、预期现象。}

{功能点 2}

{功能描述、操作方式、预期现象。}

故障排查

现象	处理
{问题描述}	{解决方法}

清理

在项目工程目录下使用xxxxx清理编译产物和中间产物。

附录

硬件方案

硬件规格

{开发板 / Sensor / 屏 / 喇叭 / 扩展板等}

引脚连接

信号	GPIO	复用功能
{信号}	{GPIO}	{功能}

注意： {接线注意事项，如上拉电阻、复位脚、TE 引线焊接等。}

方案 N：{方案名}

{规格、接口定义、硬件组网与网络连接说明。}

![图片说明](./images/{图}.png)