Skip to content

Commit 5ca406f

Browse files
committed
docs: 统一 README 正文章节结构,标准化标题命名、Installation 位置、补充缺失章节
1 parent 058dd17 commit 5ca406f

5 files changed

Lines changed: 106 additions & 92 deletions

File tree

README.ja.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,9 @@
2929
- **拡張メソッド**: 豊富な UGUI コンポーネント拡張メソッド
3030
- **フォームヘルパー**: UI フォーム作成・管理ヘルパーツール
3131

32-
## インストール
32+
## クイックスタート
33+
34+
### インストール
3335

3436
### インストール
3537

@@ -62,6 +64,26 @@ Then add the package to `dependencies`:
6264
```
6365

6466

67+
## 依存関係
68+
69+
| パッケージ | 説明 |
70+
|----------|------|
71+
| `com.gameframex.unity` | 1.1.1 |
72+
| `com.gameframex.unity.asset` | 1.0.6 |
73+
| `com.gameframex.unity.event` | 1.0.0 |
74+
| `com.gameframex.unity.ui` | 1.0.0 |
75+
76+
## ドキュメントとリソース
77+
78+
- [ドキュメント](https://gameframex.doc.alianblank.com)
79+
80+
## コミュニティとサポート
81+
82+
- QQグループ: 467608841 / 233840761
83+
84+
## 変更履歴
85+
86+
[Releases](https://github.com/GameFrameX/gameframex/com.gameframex.unity.ui.ugui/releases) で変更履歴を確認してください。
6587
## ライセンス
6688

6789
詳しくは [LICENSE.md](LICENSE.md) をご参照ください。

README.ko.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,9 @@
2929
- **확장 메서드**: 풍부한 UGUI 컴포넌트 확장 메서드
3030
- **폼 헬퍼**: UI 폼 생성 및 관리 헬퍼 도구
3131

32-
## 설치
32+
## 빠른 시작
33+
34+
### 설치
3335

3436
### 설치
3537

@@ -62,6 +64,26 @@ Then add the package to `dependencies`:
6264
```
6365

6466

67+
## 의존성
68+
69+
| 패키지 | 설명 |
70+
|--------|------|
71+
| `com.gameframex.unity` | 1.1.1 |
72+
| `com.gameframex.unity.asset` | 1.0.6 |
73+
| `com.gameframex.unity.event` | 1.0.0 |
74+
| `com.gameframex.unity.ui` | 1.0.0 |
75+
76+
## 문서 및 자료
77+
78+
- [문서](https://gameframex.doc.alianblank.com)
79+
80+
## 커뮤니티 및 지원
81+
82+
- QQ 그룹: 467608841 / 233840761
83+
84+
## 변경 로그
85+
86+
[Releases](https://github.com/GameFrameX/gameframex/com.gameframex.unity.ui.ugui/releases)에서 변경 로그를 확인하세요.
6587
## 라이선스
6688

6789
자세한 내용은 [LICENSE.md](LICENSE.md) 파일을 참조하세요.

README.md

Lines changed: 20 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -49,36 +49,6 @@ All-in-One Solution for Indie Game Development · Empowering Indie Developers' D
4949
- `UGUIComponentInspector`: UGUI component inspector
5050
- `UIImageReplaceHandler`: UI image replacement handler
5151

52-
## Installation
53-
54-
### Dependencies
55-
56-
```json
57-
{
58-
"com.gameframex.unity": "1.1.1",
59-
"com.gameframex.unity.ui": "1.0.0",
60-
"com.gameframex.unity.asset": "1.0.6",
61-
"com.gameframex.unity.event": "1.0.0"
62-
}
63-
```
64-
65-
### Installation Methods (choose one)
66-
67-
1. **Package Manager (Recommended)**
68-
- Open Unity Editor
69-
- Open Package Manager window
70-
- Click the "+" button and select "Add package from git URL"
71-
- Enter: `https://github.com/gameframex/com.gameframex.unity.ui.ugui.git`
72-
73-
2. **manifest.json**
74-
- Add the following to the `dependencies` section of your `manifest.json` file
75-
```json
76-
{"com.gameframex.unity.ui.ugui": "https://github.com/gameframex/com.gameframex.unity.ui.ugui.git"}
77-
```
78-
79-
3. **Local Installation**
80-
- Download the repository and place it in your Unity project's `Packages` directory. It will be auto-detected.
81-
8252
## Quick Start
8353

8454
### Installation
@@ -112,6 +82,26 @@ Then add the package to `dependencies`:
11282
```
11383

11484

85+
## Dependencies
86+
87+
| Package | Description |
88+
|---------|-------------|
89+
| `com.gameframex.unity` | 1.1.1 |
90+
| `com.gameframex.unity.asset` | 1.0.6 |
91+
| `com.gameframex.unity.event` | 1.0.0 |
92+
| `com.gameframex.unity.ui` | 1.0.0 |
93+
94+
## Documentation & Resources
95+
96+
- [Documentation](https://gameframex.doc.alianblank.com)
97+
98+
## Community & Support
99+
100+
- QQ Group: 467608841 / 233840761
101+
102+
## Changelog
103+
104+
See [Releases](https://github.com/GameFrameX/gameframex/com.gameframex.unity.ui.ugui/releases) for changelog.
115105
## License
116106

117107
See [LICENSE.md](LICENSE.md) for license information.

README.zh-CN.md

Lines changed: 20 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -49,36 +49,6 @@
4949
- `UGUIComponentInspector`: UGUI组件检查器
5050
- `UIImageReplaceHandler`: UI图片替换处理器
5151

52-
## 安装
53-
54-
### 依赖项
55-
56-
```json
57-
{
58-
"com.gameframex.unity": "1.1.1",
59-
"com.gameframex.unity.ui": "1.0.0",
60-
"com.gameframex.unity.asset": "1.0.6",
61-
"com.gameframex.unity.event": "1.0.0"
62-
}
63-
```
64-
65-
### 使用方式(任选其一)
66-
67-
1. **Package Manager (推荐)**
68-
- 打开Unity编辑器
69-
- 打开Package Manager窗口
70-
- 点击"+"按钮,选择"Add package from git URL"
71-
- 输入:`https://github.com/gameframex/com.gameframex.unity.ui.ugui.git`
72-
73-
2. **manifest.json**
74-
- 直接在 `manifest.json` 的文件中的 `dependencies` 节点下添加以下内容
75-
```json
76-
{"com.gameframex.unity.ui.ugui": "https://github.com/gameframex/com.gameframex.unity.ui.ugui.git"}
77-
```
78-
79-
3. **本地安装**
80-
- 直接下载仓库放置到Unity项目的`Packages`目录下,会自动加载识别
81-
8252
## 快速开始
8353

8454
### 安装
@@ -112,6 +82,26 @@ Then add the package to `dependencies`:
11282
```
11383

11484

85+
## 依赖
86+
87+
|| 说明 |
88+
|----|------|
89+
| `com.gameframex.unity` | 1.1.1 |
90+
| `com.gameframex.unity.asset` | 1.0.6 |
91+
| `com.gameframex.unity.event` | 1.0.0 |
92+
| `com.gameframex.unity.ui` | 1.0.0 |
93+
94+
## 文档与资源
95+
96+
- [官方文档](https://gameframex.doc.alianblank.com)
97+
98+
## 社区与支持
99+
100+
- QQ群: 467608841 / 233840761
101+
102+
## 更新日志
103+
104+
查看 [Releases](https://github.com/GameFrameX/gameframex/com.gameframex.unity.ui.ugui/releases) 了解更新日志。
115105
## 开源协议
116106

117107
详见 [LICENSE.md](LICENSE.md) 文件。

README.zh-TW.md

Lines changed: 20 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -49,36 +49,6 @@
4949
- `UGUIComponentInspector`: UGUI 組件檢查器
5050
- `UIImageReplaceHandler`: UI 圖片替換處理器
5151

52-
## 安裝
53-
54-
### 依賴項
55-
56-
```json
57-
{
58-
"com.gameframex.unity": "1.1.1",
59-
"com.gameframex.unity.ui": "1.0.0",
60-
"com.gameframex.unity.asset": "1.0.6",
61-
"com.gameframex.unity.event": "1.0.0"
62-
}
63-
```
64-
65-
### 安裝方式(任選其一)
66-
67-
1. **Package Manager (推薦)**
68-
- 打開 Unity 編輯器
69-
- 打開 Package Manager 窗口
70-
- 點擊"+"按鈕,選擇"Add package from git URL"
71-
- 輸入:`https://github.com/gameframex/com.gameframex.unity.ui.ugui.git`
72-
73-
2. **manifest.json**
74-
- 直接在 `manifest.json` 文件中的 `dependencies` 節點下添加以下內容
75-
```json
76-
{"com.gameframex.unity.ui.ugui": "https://github.com/gameframex/com.gameframex.unity.ui.ugui.git"}
77-
```
78-
79-
3. **本地安裝**
80-
- 直接下載倉庫放置到 Unity 項目的 `Packages` 目錄下,會自動加載識別
81-
8252
## 快速開始
8353

8454
### 安裝
@@ -112,6 +82,26 @@ Then add the package to `dependencies`:
11282
```
11383

11484

85+
## 依賴
86+
87+
| 套件 | 說明 |
88+
|------|------|
89+
| `com.gameframex.unity` | 1.1.1 |
90+
| `com.gameframex.unity.asset` | 1.0.6 |
91+
| `com.gameframex.unity.event` | 1.0.0 |
92+
| `com.gameframex.unity.ui` | 1.0.0 |
93+
94+
## 文檔與資源
95+
96+
- [官方文檔](https://gameframex.doc.alianblank.com)
97+
98+
## 社區與支援
99+
100+
- QQ群: 467608841 / 233840761
101+
102+
## 更新日誌
103+
104+
查看 [Releases](https://github.com/GameFrameX/gameframex/com.gameframex.unity.ui.ugui/releases) 了解更新日誌。
115105
## 開源協議
116106

117107
詳見 [LICENSE.md](LICENSE.md) 檔案。

0 commit comments

Comments
 (0)