From 29fcfbe0a196b6cac72efd1e5b725d6b685603f8 Mon Sep 17 00:00:00 2001 From: gewuyou <95328647+GeWuYou@users.noreply.github.com> Date: Thu, 5 Feb 2026 20:23:10 +0800 Subject: [PATCH] docs: unify module docs navigation and package guidance --- GFramework.Game.Abstractions/README.md | 14 ++++++++++++++ GFramework.Godot.SourceGenerators/README.md | 14 ++++++++++++++ README.md | 14 +++++++++++--- 3 files changed, 39 insertions(+), 3 deletions(-) create mode 100644 GFramework.Game.Abstractions/README.md create mode 100644 GFramework.Godot.SourceGenerators/README.md diff --git a/GFramework.Game.Abstractions/README.md b/GFramework.Game.Abstractions/README.md new file mode 100644 index 0000000..9ac048d --- /dev/null +++ b/GFramework.Game.Abstractions/README.md @@ -0,0 +1,14 @@ +# GFramework.Game.Abstractions + +`GFramework.Game.Abstractions` 提供 `GFramework.Game` 的抽象层接口定义，用于解耦业务逻辑与具体实现。 + +## 主要内容 + +- 游戏业务常用抽象（数据、场景、设置、存储、UI 等） +- 与 `GFramework.Core.Abstractions` 配合使用的接口契约 +- 供上层应用或扩展模块进行面向接口编程 + +## 使用建议 + +- 若你需要直接使用完整游戏扩展能力，优先安装 `GeWuYou.GFramework.Game`。 +- 若你在做模块拆分、测试替身（Mock）或跨实现解耦，可单独依赖本包。 diff --git a/GFramework.Godot.SourceGenerators/README.md b/GFramework.Godot.SourceGenerators/README.md new file mode 100644 index 0000000..4d77fc6 --- /dev/null +++ b/GFramework.Godot.SourceGenerators/README.md @@ -0,0 +1,14 @@ +# GFramework.Godot.SourceGenerators + +`GFramework.Godot.SourceGenerators` 提供面向 Godot 场景的源码生成扩展，减少模板代码与手写样板。 + +## 主要内容 + +- 与 Godot 场景相关的编译期生成能力 +- 基于 Roslyn 的增量生成器实现 +- 与 `GFramework.SourceGenerators` 协同工作 + +## 使用建议 + +- 仅在 **Godot + C#** 项目中启用。 +- 非 Godot 项目可只使用 `GeWuYou.GFramework.SourceGenerators`。 diff --git a/README.md b/README.md index b0caf3a..016603c 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,8 @@ > 面向游戏开发场景的模块化 C# 框架，核心能力与具体引擎解耦，可按需组合 Core / Game / Godot / Source Generators。 -[![NuGet](https://img.shields.io/badge/NuGet-GeWuYou.GFramework-blue)](https://www.nuget.org/packages/GeWuYou.GFramework) +[![NuGet Core](https://img.shields.io/badge/NuGet-GeWuYou.GFramework.Core-2C7BE5)](https://www.nuget.org/packages/GeWuYou.GFramework.Core) +[![NuGet Meta](https://img.shields.io/badge/NuGet-GeWuYou.GFramework-1F9D55)](https://www.nuget.org/packages/GeWuYou.GFramework) [![Godot](https://img.shields.io/badge/Godot-4.5+-green)](https://godotengine.org/) [![.NET](https://img.shields.io/badge/.NET-6.0+-purple)](https://dotnet.microsoft.com/) [![License](https://img.shields.io/badge/License-Apache%202.0-blue)](LICENSE) @@ -29,10 +30,10 @@ GFramework 采用清晰分层与模块化设计，强调： | `GFramework.Core` | 平台无关的核心架构能力（架构、命令、查询、事件、属性、IOC、日志等） | [查看](GFramework.Core/README.md) | | `GFramework.Core.Abstractions` | Core 对应的抽象接口定义 | [查看](GFramework.Core.Abstractions/README.md) | | `GFramework.Game` | 游戏业务侧扩展（状态、配置、存储、UI 等） | [查看](GFramework.Game/README.md) | -| `GFramework.Game.Abstractions` | Game 模块抽象接口定义 | 源码目录：`GFramework.Game.Abstractions/` | +| `GFramework.Game.Abstractions` | Game 模块抽象接口定义 | [查看](GFramework.Game.Abstractions/README.md) | | `GFramework.Godot` | Godot 集成层（节点扩展、场景/设置/存储适配等） | [查看](GFramework.Godot/README.md) | | `GFramework.SourceGenerators` | 通用源码生成器（日志、枚举扩展、规则等） | [查看](GFramework.SourceGenerators/README.md) | -| `GFramework.Godot.SourceGenerators` | Godot 场景下的源码生成器扩展 | 源码目录：`GFramework.Godot.SourceGenerators/` | +| `GFramework.Godot.SourceGenerators` | Godot 场景下的源码生成器扩展 | [查看](GFramework.Godot.SourceGenerators/README.md) | ## 文档导航 @@ -44,6 +45,13 @@ GFramework 采用清晰分层与模块化设计，强调： > 如果你更偏好按模块阅读，建议从各子项目 `README.md` 开始，再回到 `docs/` 查阅专题文档。 +## 包选择说明（避免混淆） + +- **`GeWuYou.GFramework`**：聚合元包（Meta Package），用于一键引入常用能力集合，适合快速试用或原型阶段。 +- **`GeWuYou.GFramework.Core`**：核心起步包，适合希望按模块精细控制依赖的项目（推荐生产项目从此起步）。 + +如果你已明确技术栈，建议优先按模块安装（Core / Game / Godot / SourceGenerators），避免不必要依赖。 + ## 快速安装 按实际需求选择依赖：