TGOSKits

TGOSKits 是一个面向操作系统与虚拟化开发的集成仓库。它使用 Git Subtree 管理 60 多个独立组件仓库，将 ArceOS、StarryOS、Axvisor 以及相关平台 crate 整合在同一工作区中，支持组件级开发、跨系统联调和统一测试。

1. 快速导航

当前仓库包含多个系统和几十个独立组件，不同开发目标对应不同的文档和命令入口。下面的表格帮助你根据当前任务快速定位到最合适的文档和最短可用命令。

2. 仓库结构

仓库按职责将代码划分为顶层目录：components/ 存放独立的可复用组件，os/ 存放三个目标系统的源码，platform/ 存放平台相关 crate，docs/ 集中管理开发者文档。scripts/repo/ 提供 subtree 管理工具。

tgoskits/
├── components/                # subtree 管理的独立组件 crate
├── os/
│   ├── arceos/                # ArceOS: modules / api / ulib / examples
│   ├── StarryOS/              # StarryOS: kernel / starryos / make
│   └── axvisor/               # Axvisor: src / configs / local xtask
├── platform/                  # 平台相关 crate
├── test-suit/                 # ArceOS / StarryOS 系统测试
├── xtask/                     # 根目录 tg-xtask
├── scripts/
│   └── repo/                  # subtree 管理脚本与 repos.csv
└── docs/                      # 开发者文档

仓库采用 main / dev / 功能分支三层策略。main 作为稳定基线，dev 作为集成分支汇聚开发和 CI 验证，开发者基于 dev 创建功能分支并通过 PR 合入（禁止直发 main）。

feature/* ──PR──► dev
                   │
                定期合并
                   ▼
                 main

与组件仓库之间如需同步，请由维护者显式执行 scripts/repo/repo.py pull/push。详见 docs/repo.md。

3. 快速体验

以下命令提供了三个系统的最小运行路径，帮助你快速验证环境是否就绪。三套系统统一使用 cargo xtask <os> <subcommand> 入口；cargo arceos、cargo starry、cargo axvisor 只是等价别名。ArceOS 可直接运行，StarryOS 需要先准备 rootfs，Axvisor 需要先使用 setup 脚本准备 Guest 镜像和配置。

git clone https://github.com/rcore-os/tgoskits.git
cd tgoskits

# ArceOS: 最快的 Hello World 路径
cargo xtask arceos qemu --package ax-helloworld --arch riscv64
# 如下命令等效
cargo arceos qemu --package ax-helloworld --arch riscv64

# StarryOS: 首次运行前先准备 rootfs
cargo xtask starry qemu --arch riscv64
# 如下命令等效
cargo starry qemu --arch riscv64

# Axvisor: 推荐使用官方 setup 脚本准备 Guest 和 rootfs
cargo xtask axvisor qemu --arch aarch64
# 如下命令等效
cargo axvisor qemu --arch aarch64

Axvisor 不能只靠 build/qemu 两条命令直接跑起来，因为运行前仍需要 Guest 镜像、VM 配置和 rootfs。推荐先用 os/axvisor/scripts/setup_qemu.sh 自动准备这些运行时资源，再执行 cargo xtask axvisor qemu --arch <arch>。完整说明见 docs/axvisor-guide.md。

4. 快速开发

对于开发来说，首先在 components/、os/arceos/modules/、os/StarryOS/kernel/ 或 os/axvisor/src/ 里找到你要修改的入口。调试时先跑最小 qemu 消费者确认功能，回归时再运行对应的 test qemu 命令。改动稳定后，再补 host / std 测试。

# host / std crate
cargo xtask test

# ArceOS：先跑最小应用，再跑统一 QEMU 测试
cargo xtask arceos qemu --package ax-helloworld --arch riscv64
cargo xtask arceos test qemu --target riscv64

# StarryOS：先准备 rootfs，跑最小启动，再跑统一 QEMU 测试
cargo xtask starry rootfs --arch riscv64
cargo xtask starry qemu --arch riscv64
cargo xtask starry test qemu --target riscv64

# Axvisor：先准备 Guest 和 rootfs，跑最小启动，再跑统一 QEMU 测试
(cd os/axvisor && ./scripts/setup_qemu.sh arceos)
cargo xtask axvisor qemu --arch aarch64
cargo xtask axvisor test qemu --target aarch64

修改组件后的验证策略见 docs/components.md。

5. 许可证

仓库整体采用 Apache-2.0 许可证。各组件可能带有自己的 LICENSE 文件，具体以各组件目录下的为准。