Files
jack bda6b60c15 docs(kaisa): make UCM HiFi the only supported path
Promote UCM2/HiFi (Jack-driven) as the primary delivery, add HISTORY.md,
remove ProAudio/REPRO docs and non-UCM scripts, and fix repo-wide references.

Made-with: Cursor
2026-04-08 15:22:45 +08:00

55 lines
2.6 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 全仓库索引(路径速查)
**当前维护文档**以根 [README.md](./README.md) 为准(**OPERATION** / **REPRO** / **next**)。
## 大目录
| 路径 | 说明 |
| ---- | ---- |
| [`.cursor/`](./.cursor/) | Cursor 配置,非业务源码 |
| [`chromiumos_kernel/v5.15/`](./chromiumos_kernel/v5.15/) | 可选对照用 ChromiumOS kernel 工作树(**本机保留、主仓库不入库**;拉取/镜像/备份见 [`chromiumos_kernel/README.md`](./chromiumos_kernel/README.md) |
| [`reference/ucm2/`](./reference/ucm2/) | Kaisa UCM2 overlay见 [reference/ucm2/README.md](./reference/ucm2/README.md) |
| [`reference/chromeos-ubuntu-sound-diffs/`](./reference/chromeos-ubuntu-sound-diffs/) | 可选:本机 `diff -u` 生成物目录(见目录内 README |
| [`_bmad/`](./_bmad/) | BMad 模块;总表 [`_bmad/_config/bmad-help.csv`](./_bmad/_config/bmad-help.csv) |
| [`_bmad-output/`](./_bmad-output/) | BMad 生成物(若存在) |
## [`docs/`](./docs/) — 正式文档
| 文件 | 说明 |
| ---- | ---- |
| [docs/linux-hdmi/OPERATION_PipeWire_Kaisa_UCM_HiFi.md](./docs/linux-hdmi/OPERATION_PipeWire_Kaisa_UCM_HiFi.md) | **主路线(交付)**UCM2 + HiFiJack-driven |
## [`audio_topology/`](./audio_topology/)
| 文件 | 说明 |
| ---- | ---- |
| [COLLECT.md](./audio_topology/COLLECT.md) | 拓扑采集用法 |
| [collect_linux_audio_topology.sh](./audio_topology/collect_linux_audio_topology.sh) 等 | 采集脚本 |
| [`collected/`](./audio_topology/collected/) | 实机 `*.txt` 等原始输出 |
## [`scripts/`](./scripts/) — 脚本
| 脚本 | 说明 |
| ---- | ---- |
| [disable-kaisa-pro-audio-wireplumber.sh](./scripts/disable-kaisa-pro-audio-wireplumber.sh) | 禁用强制 pro-audio 的 WirePlumber 片段(与 UCM 互斥) |
| [install-kaisa-ucm-overlay.sh](./scripts/install-kaisa-ucm-overlay.sh) | 安装 UCM2 overlay + `60-kaisa-ucm.lua` 到系统路径 |
| [remove-kaisa-ucm-overlay.sh](./scripts/remove-kaisa-ucm-overlay.sh) | 卸载本仓库安装的 UCM2 overlay 与系统级 `60-kaisa-ucm.lua` |
BMad 中文帮助表生成:[`_bmad/scripts/render_bmad_help_zh_cn.py`](./_bmad/scripts/render_bmad_help_zh_cn.py) → 根目录 `bmad-help.zh-CN.md`
## [`debian/`](./debian/)deb 打包草稿,**未来计划**,当前不维护)
`kaisa-hdmi-pipewire-fix` 包定义与安装文件。
## 根目录
| 文件 | 说明 |
| ---- | ---- |
| [README.md](./README.md) | 仓库说明 |
| [help.md](./help.md) | BMad 菜单码 |
## 维护
- 新增说明性文档:放入 **`docs/linux-hdmi/`** 或更新 **OPERATION**
- 大目录变更:在本文件补一行。