Document project directories and deferred USB simulation plan

This commit is contained in:
tongtong committed 2026-11-12 15:57:19 +08:00
1 parent ab9cc8d0a5
commit 0988e9c363
2 files changed
+148

No files matched your search

+34
View File
@@ -10,6 +10,40 @@
ads-agent (Rust) → 手机 adbd TCP:5555
```
## 目录说明
下表覆盖项目根目录及主要自有子项目;第三方源码的内部目录由其自身文档说明。语言列为主要语言或文件格式,产物目录不视为源码模块。
| 目录 | 作用 | 主要语言/格式 |
| --- | --- | --- |
| `agent/` | 远程设备守护程序 ads-agent,注册设备、连接手机 ADB、建立转发并重连;源码在 `src/` | Rust、TOML |
| `client/` | 本地守护程序 ads-client,维护设备租约、监听本地端口并自动调用 adb connect;源码在 `src/` | Rust、TOML |
| `server/` | 公网中继 ads-server,负责认证、设备注册、独占租约、会话配对及数据转发 | Go |
| `crates/` | Rust 工作区共享库容器 | Rust、TOML |
| `crates/ads-core/` | 共用网络与协议代码,包括 WSS、ADB smart socket 和流式转发;源码在 `src/` | Rust、TOML |
| `desktop/` | 跨平台桌面客户端及其测试项目、.NET SDK 配置与使用说明 | C#、Avalonia XAML(AXAML)、JSON、Markdown |
| `desktop/Ads.Desktop/` | Avalonia 桌面应用,管理配置、设备列表、连接、托盘及 scrcpy 子进程;`Assets/` 保存图标资源 | C#、AXAML、XML(csproj)、PNG |
| `desktop/Ads.Desktop.Tests/` | 桌面客户端单元测试 | C#、XML(csproj) |
| `desktop/Ads.Desktop.Smoke/` | 桌面离屏布局、连接及可选真机冒烟验证入口 | C#、XML(csproj) |
| `deploy/` | 服务器/设备端部署脚本与 Caddy、Nginx、systemd、launchd 配置示例 | Shell、服务/代理配置、XML(plist)、Markdown |
| `deploy/windows/` | Windows 设备端准备、安装和运行脚本,通过计划任务托管 agent,附配置示例 | PowerShell、JSON、Markdown |
| `scripts/` | 项目构建、打包及本地启动脚本 | PowerShell、Shell |
| `tests/` | Python 桥接测试、三端集成测试及可选真机验证 | Python |
| `docs/` | 协议、部署、验证及旧局域网桥接说明 | Markdown |
| `config/` | 本地配置容器;`private/` 保存私有凭据等配置,已被 Git 忽略,不纳入发布包 | 环境变量文件等配置格式,无业务源码 |
| `adb/` | 本地第三方 AOSP ADB 源码检出,用于参考与研究;已被 Git 忽略,不是 adb 可执行文件目录 | 主要为 C++,另含 Python、Shell、Android.bp |
| `scrcpy/` | 本地第三方 scrcpy 源码检出;已被 Git 忽略,不是可直接运行的发行包 | C(客户端)、Java(Android 服务端)、Meson、Gradle |
| `QtScrcpy/` | 本地第三方 QtScrcpy 源码检出,供参考与研究;已被 Git 忽略 | C++、Qt、CMake |
| `bin/` | 编译/分发产物和运行工具,如 ads 三端程序、桌面包、Linux 产物及 `tools/`;已被 Git 忽略 | 可执行文件、运行库及资源,无独立源码语言 |
| `target/` | Cargo 生成的编译产物与缓存;已被 Git 忽略 | Rust 构建产物,无独立源码语言 |
| `work/` | 本地联调、测试输出、截图、日志、工具下载与临时脚本;已被 Git 忽略,不作为正式源码入口 | 混合格式,含 Python、PowerShell、日志及图片 |
| `__pycache__/` | Python 自动生成的字节码缓存;已被 Git 忽略 | Python 字节码,无手写源码 |
| `.git/` | 当前仓库的版本控制元数据,由 Git 管理 | Git 内部数据,无业务源码 |
桌面项目下的 `bin/`、`obj/` 同样是 .NET 生成的构建产物与中间文件,已被 Git 忽略。根目录的 `adb_bridge.py` 与 `start-bridge.ps1` 是旧局域网桥接入口,分别使用 Python 和 PowerShell,不属于上述目录。
新增或调整目录时,需按 `AGENTS.md` 的目录维护约定同步说明用途和主要语言/格式。
## 程序划分
| 目录 | 输出 | 职责 |