Skip to content

Commit ae94696

Browse files
AlianBlankclaude
andcommitted
docs: 统一 Installation 章节为标准 4 种安装方式
依据 GameFrameX Installation 规范,所有 README 的 Installation 章节 必须包含 4 种安装方式:scopedRegistries / manifest.json / Git URL / Manual。 Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
1 parent 01b3167 commit ae94696

5 files changed

Lines changed: 165 additions & 0 deletions

File tree

README.ja.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,39 @@ Unity 向けの改良版 LitJson ライブラリ。[XINCGer/LitJson4Unity](https
2929

3030
## クイックスタート
3131

32+
### インストール
33+
34+
以下のいずれかの方法を選択してください:
35+
36+
1. Unity プロジェクトの `Packages/manifest.json` を編集し、`scopedRegistries` セクションを追加してください:
37+
```json
38+
{
39+
"scopedRegistries": [
40+
{
41+
"name": "GameFrameX",
42+
"url": "https://gameframex.upm.alianblank.uk",
43+
"scopes": [
44+
"com.gameframex"
45+
]
46+
}
47+
],
48+
"dependencies": {
49+
"com.gameframex.unity.xincger.litjson": "1.1.2"
50+
}
51+
}
52+
```
53+
54+
`scopes` は、どのパッケージをこのレジストリから解決するかを制御します。`com.gameframex` で始まるパッケージのみがこのレジストリから取得されます。
55+
56+
2. `manifest.json``dependencies` に直接追加:
57+
```json
58+
{
59+
"com.gameframex.unity.xincger.litjson": "https://github.com/gameframex/com.gameframex.unity.xincger.litjson.git"
60+
}
61+
```
62+
3. Unity の **Package Manager****Git URL** を使用して追加:`https://github.com/gameframex/com.gameframex.unity.xincger.litjson.git`
63+
4. リポジトリを Unity プロジェクトの `Packages` ディレクトリにクローンしてください。自動的に読み込まれます。
64+
3265
Unity プロジェクトの `Packages/manifest.json` を編集し、`scopedRegistries` セクションを追加してください:
3366

3467
```json

README.ko.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,39 @@ Unity용 개선된 LitJson 라이브러리로, [XINCGer/LitJson4Unity](https://g
2929

3030
## 빠른 시작
3131

32+
### 설치
33+
34+
다음 방법 중 하나를 선택하세요:
35+
36+
1. Unity 프로젝트의 `Packages/manifest.json`을 편집하여 `scopedRegistries` 섹션을 추가하세요:
37+
```json
38+
{
39+
"scopedRegistries": [
40+
{
41+
"name": "GameFrameX",
42+
"url": "https://gameframex.upm.alianblank.uk",
43+
"scopes": [
44+
"com.gameframex"
45+
]
46+
}
47+
],
48+
"dependencies": {
49+
"com.gameframex.unity.xincger.litjson": "1.1.2"
50+
}
51+
}
52+
```
53+
54+
`scopes`는 이 레지스트리를 통해 어떤 패키지를 해석할지 제어합니다. `com.gameframex`로 시작하는 패키지만 이 레지스트리에서 가져옵니다.
55+
56+
2. `manifest.json``dependencies`에 직접 추가:
57+
```json
58+
{
59+
"com.gameframex.unity.xincger.litjson": "https://github.com/gameframex/com.gameframex.unity.xincger.litjson.git"
60+
}
61+
```
62+
3. Unity의 **Package Manager**에서 **Git URL**을 사용하여 추가: `https://github.com/gameframex/com.gameframex.unity.xincger.litjson.git`
63+
4. 리포지토리를 Unity 프로젝트의 `Packages` 디렉토리에 클론하세요. 자동으로 로드됩니다.
64+
3265
Unity 프로젝트의 `Packages/manifest.json`을 편집하여 `scopedRegistries` 섹션을 추가하세요:
3366

3467
```json

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,39 @@ This library serves as a sub-module for [GameFrameX](https://github.com/AlianBla
2929

3030
## Quick Start
3131

32+
### Installation
33+
34+
Choose one of the following methods:
35+
36+
1. Edit your Unity project's `Packages/manifest.json` and add the `scopedRegistries` section:
37+
```json
38+
{
39+
"scopedRegistries": [
40+
{
41+
"name": "GameFrameX",
42+
"url": "https://gameframex.upm.alianblank.uk",
43+
"scopes": [
44+
"com.gameframex"
45+
]
46+
}
47+
],
48+
"dependencies": {
49+
"com.gameframex.unity.xincger.litjson": "1.1.2"
50+
}
51+
}
52+
```
53+
54+
`scopes` controls which packages are resolved through this registry. Only packages whose names start with `com.gameframex` will be fetched from it.
55+
56+
2. Add to `manifest.json` dependencies:
57+
```json
58+
{
59+
"com.gameframex.unity.xincger.litjson": "https://github.com/gameframex/com.gameframex.unity.xincger.litjson.git"
60+
}
61+
```
62+
3. Use **Package Manager** in Unity with **Git URL**: `https://github.com/gameframex/com.gameframex.unity.xincger.litjson.git`
63+
4. Clone the repository into your Unity project's `Packages` directory. It will be loaded automatically.
64+
3265
Edit your Unity project's `Packages/manifest.json` and add the `scopedRegistries` section:
3366

3467
```json

README.zh-CN.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,39 @@
2929

3030
## 快速开始
3131

32+
### 安装
33+
34+
选择以下任一方式:
35+
36+
1. 编辑 Unity 项目的 `Packages/manifest.json`,添加 `scopedRegistries` 部分:
37+
```json
38+
{
39+
"scopedRegistries": [
40+
{
41+
"name": "GameFrameX",
42+
"url": "https://gameframex.upm.alianblank.uk",
43+
"scopes": [
44+
"com.gameframex"
45+
]
46+
}
47+
],
48+
"dependencies": {
49+
"com.gameframex.unity.xincger.litjson": "1.1.2"
50+
}
51+
}
52+
```
53+
54+
`scopes` 控制哪些包通过此注册表解析。只有以 `com.gameframex` 开头的包才会从这个注册表获取。
55+
56+
2. 直接在 `manifest.json``dependencies` 节点下添加以下内容:
57+
```json
58+
{
59+
"com.gameframex.unity.xincger.litjson": "https://github.com/gameframex/com.gameframex.unity.xincger.litjson.git"
60+
}
61+
```
62+
3. 在 Unity 的 `Package Manager` 中使用 `Git URL` 的方式添加库,地址为:`https://github.com/gameframex/com.gameframex.unity.xincger.litjson.git`
63+
4. 直接下载仓库放置到 Unity 项目的 `Packages` 目录下,会自动加载识别。
64+
3265
编辑 Unity 项目的 `Packages/manifest.json`,添加 `scopedRegistries` 部分:
3366

3467
```json

README.zh-TW.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,39 @@
2929

3030
## 快速開始
3131

32+
### 安裝
33+
34+
選擇以下任一方式:
35+
36+
1. 編輯 Unity 專案的 `Packages/manifest.json`,添加 `scopedRegistries` 部分:
37+
```json
38+
{
39+
"scopedRegistries": [
40+
{
41+
"name": "GameFrameX",
42+
"url": "https://gameframex.upm.alianblank.uk",
43+
"scopes": [
44+
"com.gameframex"
45+
]
46+
}
47+
],
48+
"dependencies": {
49+
"com.gameframex.unity.xincger.litjson": "1.1.2"
50+
}
51+
}
52+
```
53+
54+
`scopes` 控制哪些套件透過此註冊表解析。只有以 `com.gameframex` 開頭的套件才會從這個註冊表取得。
55+
56+
2. 直接在 `manifest.json``dependencies` 節點下添加以下內容:
57+
```json
58+
{
59+
"com.gameframex.unity.xincger.litjson": "https://github.com/gameframex/com.gameframex.unity.xincger.litjson.git"
60+
}
61+
```
62+
3. 在 Unity 的 `Package Manager` 中使用 `Git URL` 的方式添加庫,地址為:`https://github.com/gameframex/com.gameframex.unity.xincger.litjson.git`
63+
4. 直接下載倉庫放置到 Unity 專案的 `Packages` 目錄下,會自動載入識別。
64+
3265
編輯 Unity 專案的 `Packages/manifest.json`,添加 `scopedRegistries` 部分:
3366

3467
```json

0 commit comments

Comments
 (0)