docs: 完善 README,精简 CLAUDE.md

- 重写 README:补充技术栈徽标、快速开始、项目结构、线上体验链接
- 简化 CLAUDE.md:目录结构和架构说明改为引用 docs/architecture.md
- 移除不存在的 lint/test 命令
- 删除无内容的 README.en.md
This commit is contained in:
2026-05-23 18:05:53 +08:00
parent a0823dc64d
commit e63165f898
3 changed files with 48 additions and 151 deletions
+46 -24
View File
@@ -1,37 +1,59 @@
# gen2d
#### 介绍
🎨 AI 驱动的 2D 游戏素材生成工具。通过文本提示词或可视化参数,快速生成风格一致、管线友好的 Sprite、背景、UI 与动画帧。支持 Unity/Godot 一键集成,兼顾生成效率、画质与低成本工作流。
AI 驱动的 2D 游戏素材生成工具。通过文本提示词或可视化参数,快速生成风格一致、管线友好的 Sprite、背景、UI 元素与动画帧。支持 Unity / Godot 一键集成。
#### 软件架构
软件架构说明
[![Go](https://img.shields.io/badge/Go-00ADD8?logo=go&logoColor=white)](https://go.dev/)
[![Gin](https://img.shields.io/badge/Gin-008ECF?logo=gin&logoColor=white)](https://gin-gonic.com/)
[![React](https://img.shields.io/badge/React-61DAFB?logo=react&logoColor=black)](https://react.dev/)
[![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
[![Vite](https://img.shields.io/badge/Vite-646CFF?logo=vite&logoColor=white)](https://vite.dev/)
### **[在线体验 http://47.121.181.112:10000](http://47.121.181.112:10000)**
#### 安装教程
架构采用多智能体协作管线(PromptBuilder → AssetGenerator → QualitySupervisor → FormatAdapter),详见 [docs/architecture.md](docs/architecture.md)。
1. xxxx
2. xxxx
3. xxxx
## 快速开始
#### 使用说明
### 后端
1. xxxx
2. xxxx
3. xxxx
```bash
cd backend
go mod tidy
go run cmd/main.go
```
#### 参与贡献
服务默认运行在 `http://localhost:8080`。
1. Fork 本仓库
2. 新建 Feat_xxx 分支
3. 提交代码
4. 新建 Pull Request
### 前端
```bash
cd frontend
npm install
npm run dev
```
#### 特技
开发服务器默认运行在 `http://localhost:5173`,通过 Vite proxy 转发 API 请求到后端。
1. 使用 Readme\_XXX.md 来支持不同的语言,例如 Readme\_en.md, Readme\_zh.md
2. Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com)
3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目
4. [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目,是综合评定出的优秀开源项目
5. Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)
## 项目结构
```
gen2d/
├── backend/ # Go + Gin API 服务
├── frontend/ # Vite + React 前端
└── docs/ # 项目文档
├── architecture.md # 架构设计
└── api.md # API 文档
```
详细架构说明见 [docs/architecture.md](docs/architecture.md)。
## API
接口统一前缀 `/api/v1/`,详见 [docs/api.md](docs/api.md)。
## 参与贡献
1. Fork 本仓库
2. 新建 Feat_xxx 分支
3. 提交代码
4. 新建 Pull Request