Skip to content

Commit c1042c4

Browse files
committed
docs(readme): 添加 Docker 镜像使用说明
为所有语言版本的 README 添加 Docker 章节,包含 Docker Hub 和 GHCR 的拉取方式及使用示例。
1 parent eca616e commit c1042c4

5 files changed

Lines changed: 130 additions & 0 deletions

File tree

README.ja.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,32 @@
2424

2525
Proto プロトコルファイルを `Server/Unity/TypeScript/Godot` コードに変換するツールです。
2626

27+
# Docker
28+
29+
`linux/amd64` および `linux/arm64` 用の Docker イメージが提供されています。
30+
31+
**Docker Hub**
32+
33+
```bash
34+
docker pull gameframex/gameframex-tools:latest
35+
```
36+
37+
**GitHub Container Registry (GHCR)**
38+
39+
```bash
40+
docker pull ghcr.io/gameframex/gameframex.tools:latest
41+
```
42+
43+
**使用例**
44+
45+
```bash
46+
docker run --rm \
47+
-v /path/to/protos:/protos \
48+
-v /path/to/output:/output \
49+
gameframex/gameframex-tools:latest \
50+
--mode server --inputpath /protos --outputpath /output --namespaceName GameFrameX.Proto.Proto
51+
```
52+
2753
# パラメータ解説
2854

2955
このツールのコマンドラインパラメータの詳細説明は以下の通りです。

README.ko.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,32 @@
2424

2525
Proto 프로토콜 파일을 `Server/Unity/TypeScript/Godot` 코드로 변환하는 도구입니다.
2626

27+
# Docker
28+
29+
`linux/amd64``linux/arm64` 용 Docker 이미지가 제공됩니다.
30+
31+
**Docker Hub**
32+
33+
```bash
34+
docker pull gameframex/gameframex-tools:latest
35+
```
36+
37+
**GitHub Container Registry (GHCR)**
38+
39+
```bash
40+
docker pull ghcr.io/gameframex/gameframex.tools:latest
41+
```
42+
43+
**사용 예시**
44+
45+
```bash
46+
docker run --rm \
47+
-v /path/to/protos:/protos \
48+
-v /path/to/output:/output \
49+
gameframex/gameframex-tools:latest \
50+
--mode server --inputpath /protos --outputpath /output --namespaceName GameFrameX.Proto.Proto
51+
```
52+
2753
# 매개변수 설명
2854

2955
이 도구의 명령줄 매개변수에 대한 자세한 설명은 다음과 같습니다.

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,32 @@
2424

2525
A tool for converting Proto protocol files into `Server/Unity/TypeScript/Godot` code.
2626

27+
# Docker
28+
29+
Pre-built Docker images are available for `linux/amd64` and `linux/arm64`.
30+
31+
**Docker Hub**
32+
33+
```bash
34+
docker pull gameframex/gameframex-tools:latest
35+
```
36+
37+
**GitHub Container Registry (GHCR)**
38+
39+
```bash
40+
docker pull ghcr.io/gameframex/gameframex.tools:latest
41+
```
42+
43+
**Usage**
44+
45+
```bash
46+
docker run --rm \
47+
-v /path/to/protos:/protos \
48+
-v /path/to/output:/output \
49+
gameframex/gameframex-tools:latest \
50+
--mode server --inputpath /protos --outputpath /output --namespaceName GameFrameX.Proto.Proto
51+
```
52+
2753
# Parameter Reference
2854

2955
Below is a detailed description of the command-line parameters for this tool.

README.zh-CN.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,32 @@
2424

2525
这是一个用于将Proto协议文件转换为 `Server/Unity/TypeScript/Godot` 代码的工具。
2626

27+
# Docker
28+
29+
预构建的 Docker 镜像支持 `linux/amd64``linux/arm64` 架构。
30+
31+
**Docker Hub**
32+
33+
```bash
34+
docker pull gameframex/gameframex-tools:latest
35+
```
36+
37+
**GitHub Container Registry (GHCR)**
38+
39+
```bash
40+
docker pull ghcr.io/gameframex/gameframex.tools:latest
41+
```
42+
43+
**使用示例**
44+
45+
```bash
46+
docker run --rm \
47+
-v /path/to/protos:/protos \
48+
-v /path/to/output:/output \
49+
gameframex/gameframex-tools:latest \
50+
--mode server --inputpath /protos --outputpath /output --namespaceName GameFrameX.Proto.Proto
51+
```
52+
2753
# 参数解析
2854

2955
以下是此工具命令行参数的详细说明:

README.zh-TW.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,32 @@
2424

2525
這是一個用於將Proto協議文件轉換為 `Server/Unity/TypeScript/Godot` 程式碼的工具。
2626

27+
# Docker
28+
29+
預建構的 Docker 映像檔支援 `linux/amd64``linux/arm64` 架構。
30+
31+
**Docker Hub**
32+
33+
```bash
34+
docker pull gameframex/gameframex-tools:latest
35+
```
36+
37+
**GitHub Container Registry (GHCR)**
38+
39+
```bash
40+
docker pull ghcr.io/gameframex/gameframex.tools:latest
41+
```
42+
43+
**使用範例**
44+
45+
```bash
46+
docker run --rm \
47+
-v /path/to/protos:/protos \
48+
-v /path/to/output:/output \
49+
gameframex/gameframex-tools:latest \
50+
--mode server --inputpath /protos --outputpath /output --namespaceName GameFrameX.Proto.Proto
51+
```
52+
2753
# 參數解析
2854

2955
以下是此工具命令列參數的詳細說明:

0 commit comments

Comments
 (0)