From 1821cb507a33a867b21c60beb6fadcace38b01a8 Mon Sep 17 00:00:00 2001 From: bewaterhere-coder Date: Sun, 1 Nov 2026 19:33:23 +0800 Subject: [PATCH 1/2] docs: add sample project to first-run CLI quickstart --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index b5b57f7..2e5a371 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,9 @@ python -m pip install . ```sh frameforge --plugins +# 先检查仓库自带的完整示例,无需创建 Profile +frameforge examples/sample-game-godot +# 再检查你自己的游戏项目 frameforge /path/to/your/game-project ``` @@ -101,6 +104,9 @@ List available plugins, then inspect your own Unity or other game project: ```sh frameforge --plugins +# Inspect the included sample first; no Profile setup is needed +frameforge examples/sample-game-godot +# Then inspect your own game project frameforge /path/to/your/game-project ``` From 467714697bc9a80ba52a87992ea68c9610a9a85e Mon Sep 17 00:00:00 2001 From: bewaterhere-coder Date: Sun, 1 Nov 2026 19:33:28 +0800 Subject: [PATCH 2/2] docs: demonstrate first inspection with included sample --- docs/best-practices.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/best-practices.md b/docs/best-practices.md index e8fe0be..ae92ea9 100644 --- a/docs/best-practices.md +++ b/docs/best-practices.md @@ -11,6 +11,9 @@ git clone https://github.com/bewaterhere-coder/FrameForge-Community.git cd FrameForge-Community python -m pip install . frameforge --plugins +# 先检查仓库自带的 Godot 示例,观察真实 Profile 和规范绑定 +frameforge examples/sample-game-godot +# 再检查自己的项目 frameforge /path/to/your/game-project ``` @@ -88,6 +91,9 @@ git clone https://github.com/bewaterhere-coder/FrameForge-Community.git cd FrameForge-Community python -m pip install . frameforge --plugins +# Inspect the included Godot sample and its real Profile/standards bindings +frameforge examples/sample-game-godot +# Then inspect your own project frameforge /path/to/your/game-project ```