# GitHub CPU Validation Example (SLWChipVerify)

这个 example 演示如何对热门开源 CPU 项目执行 SLWChipVerify 一键验证流程，并生成可复现结果。

## 已验证项目（按 GitHub Stars）

- `riscv-mcu/e203_hbirdv2`（约 1811 stars）
  - 目录：`rtl`
  - 顶层：`e203_cpu_top`
- `ultraembedded/riscv`（约 1703 stars）
  - 目录：`core/riscv`
  - 顶层：`riscv_core`
- `ZipCPU/zipcpu`（约 1535 stars）
  - 目录：`rtl`
  - 顶层：`zipcore`

> Stars 基于 2026-04-19 采样，后续会变化。

## 前置要求

- Python 3.9+
- `git`
- `iverilog`
- `vvp`
- 可访问 GitHub 网络

## 一键复现

在安装目录执行：

```bash
python3 slwchipverify/examples/github_cpu_validation/run_github_cpu_validation.py
```

运行后会：

- 自动克隆/更新目标仓库到临时目录
- 对每个项目调用 `slwchipverify/one_click_verify.py`
- 在 `slwchipverify/examples/github_cpu_validation/results/` 下生成：
  - 每个项目的 TB / 波形 / 仿真日志 / run.log
  - 汇总报告 `github_cpu_validation_summary.json`

## 打包 example

```bash
./slwchipverify/examples/github_cpu_validation/package_example.sh
```

会在 `slwchipverify/examples/github_cpu_validation/dist/` 下生成 zip 包，包含：

- `projects.json`
- `run_github_cpu_validation.py`
- 本说明文档
- `results/` 中的汇总报告与验证产物

## 说明

- 该 example 重点验证工具在真实开源 CPU 仓库上的可用性（冒烟级编译+仿真+波形）。
- 对于特别复杂的 SoC 工程，可能仍需定制宏定义、文件筛选或更细粒度目录选择。