Files
sloray 6a0eb14b28
构建客户端 / 检查(类型 + 单元测试) (push) Waiting to run
构建客户端 / Linux x64(deb + AppImage) (push) Blocked by required conditions
构建客户端 / Windows x64(NSIS 安装包) (push) Blocked by required conditions
构建客户端 / macOS 通用(.app + .dmg) (push) Blocked by required conditions
docs: 整理项目文档并统一界面表述
将项目说明按主题集中到 docs,补齐根目录 README 和 AGENTS,移除弃用方案并保留有效测试记录与未实现提案。同步文档索引、引用及改动日志生成路径,README 增加 GitHub Markdown 导航和 Mermaid 图。

- fix(client): 统一状态与操作文案,录制和截图成功后再显示完成提示
- test(client): 按文件名核对媒体类型,避免依赖时间戳排序

验证:23 份项目文档、144 处本地引用、27 条外链、2 张 Mermaid 图;前端构建和 12 项测试;截图与录制的 4 条异步反馈路径;Windows Rust 编译检查和后端测试。后端 40 项返回成功,其中 3 项 ffmpeg 集成用例因本机缺少工具而未实际执行。
2026-10-19 11:26:26 +08:00

3.0 KiB
Raw Permalink Blame History

RMIC::2026 文档

从使用步骤进入,再按问题查阅硬件、实现和测试记录。代码命令默认从仓库根目录执行;需要切换目录的地方会注明。

项目概览与架构图见 README,工具链、验证命令和仓库协作约定见 AGENTS。

入门与使用

  • 图传固件入门:硬件要求、Rust / ESP-IDF 环境、参数、编译与烧录。
  • 桌面客户端:用户端与裁判端、配置、密码、录制、演示与浏览器预览。
  • 固件维护:USB 更新、固件包、候选槽位、备份与校验。
  • 故障排查:工具链、网络、相机与图传问题。

开发与源码说明

  • 开发与验证:镜像导出、主机测试、构建缓存与探测脚本。
  • 版本维护:Conventional Commits、版本计算与生成文件。
  • 图传板硬件:引脚、PSRAM、分区、故障 Flash 与驱动补丁。
  • 装甲板:接线、受击规则、上报、构建与实现要点。
  • UDP 协议:线路格式、版本通告、帧重组与拒收条件。

测试与排查记录

以下是特定配置、板卡和时间窗口的记录;不同轮次的数字不能直接视为同一配置的结果。

发布记录与提案

文档维护

本仓库参考 Firefox 文档首页按入门、开发、源码、测试和发布分组,并用索引串联主题。这里统一使用 Markdown,不引入 Firefox 的整套文档构建工具。

除 README.md 和 AGENTS.md(或 Agents.md)外,项目说明集中放在 docs/。根目录 README 介绍项目并链接到文档;子项目 README 保留简短入口。第三方组件的 README、许可证、构建文件、运行时配置和测试数据保留各自位置。

新增文档时先选择主题目录,再补充本页链接。迁移时同步修改相对链接、标题锚点与生成脚本。已被实现取代或已放弃的方案可以删除,历史仍可从 Git 查阅;仍需使用的实验记录保留条件、日期与验证范围,提案须明确标注状态。