From 0e711ac1062e91cf8979c693fe677c637e69d03f Mon Sep 17 00:00:00 2001 From: DKChan <524912269@qq.com> Date: Tue, 20 Oct 2026 00:36:57 +0800 Subject: [PATCH] =?UTF-8?q?docs(readme):=20=E6=A0=B9=20README=20=E8=90=BD?= =?UTF-8?q?=E5=9C=B0=E4=B8=BA=E7=BA=AF=E6=8C=87=E8=B7=AF=E7=89=8C=E2=80=94?= =?UTF-8?q?=E2=80=94=E8=AE=BE=E8=AE=A1/=E6=B5=81=E7=A8=8B/=E5=BD=93?= =?UTF-8?q?=E5=89=8D=E4=BD=8D/=E5=BE=85=E5=8A=9E=E5=9B=9B=E4=B8=AA?= =?UTF-8?q?=E9=93=BE=E6=8E=A5=E9=9B=B6=E8=A7=84=E5=88=99=E9=87=8D=E8=BF=B0?= =?UTF-8?q?=EF=BC=88=E7=94=A8=E6=88=B7=E8=A3=81=EF=BC=9A=E5=8F=AA=E8=A6=81?= =?UTF-8?q?=E5=91=8A=E8=AF=89=E5=88=AB=E4=BA=BA=E6=80=8E=E4=B9=88=E5=BC=80?= =?UTF-8?q?=E5=8F=91=E7=9A=84=E4=BB=8B=E7=BB=8D=EF=BC=8C=E6=9D=83=E5=A8=81?= =?UTF-8?q?=E5=90=84=E8=87=AA=E5=8E=9F=E6=96=87=E6=89=BF=E6=8B=85=EF=BC=89?= =?UTF-8?q?=EF=BC=9B=E5=90=8C=E6=89=B9=E4=B8=A4=E5=A4=84=E7=99=BD=E5=90=8D?= =?UTF-8?q?=E5=8D=95=E4=B9=89=E5=8A=A1=EF=BC=9AAGENTS.md=20Project=20Layou?= =?UTF-8?q?t=20=E6=A0=B9=E7=9B=AE=E5=BD=95=E8=A1=8C=EF=BC=8Brepo=5Fstructu?= =?UTF-8?q?re=5Faudit=20ROOT=5FFILES?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- AGENTS.md | 2 +- README.md | 12 ++++++++++++ tools/repo_structure_audit.py | 2 +- 3 files changed, 14 insertions(+), 2 deletions(-) create mode 100644 README.md diff --git a/AGENTS.md b/AGENTS.md index a74b6c9a..48f65ded 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -33,7 +33,7 @@ - `sim-data/` — 机器读数据产物；数据件不入 git（入库例外 = README+analyze.py+growth_model.py）；MC 锚与读数常驻留盘，无数值调整禁重跑 - `tools/` — python 工具脚本；`archive/` — 收口归档 zip（gitignored） - `reports/` — 迭代批产出物（实现报告/代拍板追认单/GDD 反哺点清单）；**实现批唯一可写目录**，只放 .md，不是事实源（细则见 `reports/README.md`） -- 根目录：`roadmap.md`（里程碑＋迭代总表六列＋顶部「当前位」节＝现在做什么）、`stage.txt`/`review-mode.txt`（运行开关）；仓库根禁止再设会话状态文件（2026-10-18 用户裁，细则见 doc-conventions 第 10 节） +- 根目录：`README.md`（纯指路牌：设计/流程/当前位/待办四个链接，零规则重述）、`roadmap.md`（里程碑＋迭代总表六列＋顶部「当前位」节＝现在做什么）、`stage.txt`/`review-mode.txt`（运行开关）；仓库根禁止再设会话状态文件（2026-10-18 用户裁，细则见 doc-conventions 第 10 节） ## 规范导航（动手前先查表） diff --git a/README.md b/README.md new file mode 100644 index 00000000..983b5123 --- /dev/null +++ b/README.md @@ -0,0 +1,12 @@ +# Dungeon Sweeper（扫雷 × 自动战斗 闯关 Roguelike） + +扫雷推理层＋自动战斗结算的两段式回合 Roguelike。个人开发，Godot 4.7 · GDScript。 + +本 README 只是路牌——不重述任何规则，想知道什么去唯一权威处： + +| 想知道 | 去看 | +|---|---| +| 这个游戏设计成什么样 | [design/gdd/02-系统清单.md](design/gdd/02-系统清单.md)（GDD 根索引） | +| 开发流程怎么走（五段流水线/批次纪律/验收闸） | [design/dev/process-conventions.md](design/dev/process-conventions.md)＋[AGENTS.md](AGENTS.md) 规范导航表（每段一个技能入口） | +| 现在做什么 | [roadmap.md](roadmap.md) 顶部「当前位」节 | +| 待办与待裁 | [design/gdd/06-待办清单.md](design/gdd/06-待办清单.md) | diff --git a/tools/repo_structure_audit.py b/tools/repo_structure_audit.py index 3425a3db..c08ff25f 100644 --- a/tools/repo_structure_audit.py +++ b/tools/repo_structure_audit.py @@ -25,7 +25,7 @@ ROOT = Path(__file__).resolve().parent.parent # 清单的家——实现批只准往这里写，design/ 全目录对它只读。只放 .md，不放图（图像白名单不含此目录）。 TOP_DIRS = {"archive", "artwork", "design", "game", "sim-data", "tools", "reports"} # 2) 根目录文件白名单 -ROOT_FILES = {"AGENTS.md", "roadmap.md", "stage.txt", "review-mode.txt", +ROOT_FILES = {"AGENTS.md", "README.md", "roadmap.md", "stage.txt", "review-mode.txt", ".gitignore", ".zcodeignore"} # 3) 图像允许目录（相对路径前缀；archive/ 为归档 zip 不扫） # design/qa/ 收编（迭代 5 返工批 2026-09-29——U2 目检预览图/QA 呈现产物归位，commit 留痕）