Skip to content

Commit fce6418

Browse files
committed
chore: update README and AGENTS documentation for synchronization process
- Revised the synchronization process for multi-language README files to reflect updates in the `static/locales/registry.json` structure. - Enhanced clarity in the AGENTS documentation regarding the `/sync_readme` command, specifying the update mechanism for various language files in the `docs/readme/` directory. - Adjusted README sections to improve the organization of deployment instructions for both source code and Docker setups.
1 parent 25e673e commit fce6418

File tree

6 files changed

+63
-63
lines changed

6 files changed

+63
-63
lines changed

.cursor/commands/sync_readme.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
1. 读取 `tools/i18n/locales.json`,获取 `locales` 列表;排除 `source_of_truth: true` 的项(即 zh-CN,对应主 `README.md`)。
1+
1. 读取 `static/locales/registry.json` 中的 `locales` 列表;排除带 `source_of_truth: true` 的项(即 zh-CN,对应主 `README.md`)。
22
2. 对每个需同步的 locale,目标文件为 `docs/readme/{CODE}_README.md``CODE` 规则:locale code 全大写并保留连字符(如 `zh-TW``ZH-TW``vi-VN``VI-VN`);`en-US` 特殊为 `EN`。可参考 `docs/readme/` 下已有文件名。
33
3. 读取主 `README.md` (简体中文) 的内容,对比各目标文件的内容差异。
44
4.`README.md` 中新增或修改的内容,分别准确地翻译并更新到各目标文件中。
55
5. 保持原有目标文件的排版格式和 Markdown 语法(如标题、列表、代码块等),注意图片等静态资源的引用路径也要保持各文件本身的正确性。
66
6. 翻译要符合对应语言开发者的阅读习惯,专业且自然;繁体中文需符合港台用语习惯;越南语需符合越南语表达习惯。
77
7. 仅更新对应的多语言 README 文件,不要修改主 `README.md` 文件。
8-
8. qq群的入群答案不翻译,保持 literal 相同。
8+
8. qq群的入群答案不翻译,保持 literal 相同。

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@
7575
|---|---|---|
7676
| `.cursor/commands/pack_to_github.md` | `/pack_to_github` | 依次执行 GitHub 打包流程:`pack_github.ps1` -> `compress.ps1` -> `release.ps1`|
7777
| `.cursor/commands/pack_to_steam.md` | `/pack_to_steam` | 依次执行 Steam 打包流程:`pack_steam.ps1` -> `upload_steam.ps1`(需人工输密码)。 |
78-
| `.cursor/commands/sync_readme.md` | `/sync_readme` |`README.md` 为源,同步翻译更新 `EN_README.md``ZH-TW_README.md`|
78+
| `.cursor/commands/sync_readme.md` | `/sync_readme` |`README.md` 为源,`static/locales/registry.json` 中需同步语言,更新 `docs/readme/` 下各 `*_README.md`|
7979
| `.cursor/commands/update_version.md` | `/update_version` | 打 tag、更新 `static/config.yml` 版本并提交。 |
8080
| `.cursor/commands/sync_agents.md` | `/sync_agents` | 重新扫描 `.cursor` 并更新根目录 `AGENTS.md`(本次新增)。 |
8181

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -90,27 +90,15 @@
9090

9191
### 推荐方式
9292

93-
- **想直接体验**:优先使用 Docker 一键部署。
9493
- **想改代码或调试**:使用源码部署,并准备 Python `3.10+`、Node.js `18+` 和可用的模型服务。
94+
- **想直接体验**:优先使用 Docker 一键部署。
9595

9696
### 首次启动说明
9797

98-
- 无论使用 Docker 还是源码开发,首次进入后都需要先在设置页配置可用的模型预设(如 DeepSeek / Ollama),再开始新游戏。
98+
- 无论使用源码还是 Docker,首次进入后都需要先在设置页配置可用的模型预设(如 DeepSeek / Ollama),再开始新游戏。
9999
- 开发模式下,前端页面通常会自动打开;如果没有自动打开,请访问启动日志中显示的前端地址。
100100

101-
### 方式一:Docker 一键部署(推荐)
102-
103-
无需配置环境,直接运行即可:
104-
105-
```bash
106-
git clone https://github.com/4thfever/cultivation-world-simulator.git
107-
cd cultivation-world-simulator
108-
docker-compose up -d --build
109-
```
110-
111-
访问前端:`http://localhost:8123`
112-
113-
### 方式二:源码部署(开发模式)
101+
### 方式一:源码部署(开发模式,推荐)
114102

115103
适合需要修改代码或调试的开发者。
116104

@@ -132,6 +120,18 @@ docker-compose up -d --build
132120
3. **访问前端**
133121
开发模式会自动拉起前端开发服务器,请访问启动日志中显示的前端地址,通常为 `http://localhost:5173`
134122

123+
### 方式二:Docker 一键部署
124+
125+
无需配置环境,直接运行即可:
126+
127+
```bash
128+
git clone https://github.com/4thfever/cultivation-world-simulator.git
129+
cd cultivation-world-simulator
130+
docker-compose up -d --build
131+
```
132+
133+
访问前端:`http://localhost:8123`
134+
135135
### 📱 高级功能
136136

137137
<details>

docs/readme/EN_README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -90,27 +90,15 @@ In the simulator, every cultivator is an independent Agent that can freely obser
9090

9191
### Recommended Path
9292

93-
- **Just want to play**: Use Docker for the fastest setup.
9493
- **Want to modify code or debug**: Use the source setup and prepare Python `3.10+`, Node.js `18+`, and an available model service.
94+
- **Just want to play**: Prefer Docker for one-click deployment.
9595

9696
### First Launch
9797

98-
- Whether you use Docker or the source setup, you need to configure an available model preset on the settings page, such as DeepSeek or Ollama, before starting a new game.
98+
- Whether you use the source setup or Docker, you need to configure an available model preset on the settings page, such as DeepSeek or Ollama, before starting a new game.
9999
- In development mode, the frontend page usually opens automatically. If it does not, use the frontend URL shown in the startup logs.
100100

101-
### Option 1: Docker One-Click Deployment (Recommended)
102-
103-
No environment configuration needed, just run:
104-
105-
```bash
106-
git clone https://github.com/4thfever/cultivation-world-simulator.git
107-
cd cultivation-world-simulator
108-
docker-compose up -d --build
109-
```
110-
111-
Open the frontend: `http://localhost:8123`
112-
113-
### Option 2: Source Code Deployment (Development Mode)
101+
### Option 1: Source Code Deployment (Development Mode, Recommended)
114102

115103
Suitable for developers who need to modify code or debug.
116104

@@ -132,6 +120,18 @@ Suitable for developers who need to modify code or debug.
132120
3. **Open the Frontend**
133121
Development mode starts the frontend dev server automatically. Open the frontend URL shown in the startup logs, which is usually `http://localhost:5173`.
134122

123+
### Option 2: Docker One-Click Deployment
124+
125+
No environment configuration needed, just run:
126+
127+
```bash
128+
git clone https://github.com/4thfever/cultivation-world-simulator.git
129+
cd cultivation-world-simulator
130+
docker-compose up -d --build
131+
```
132+
133+
Open the frontend: `http://localhost:8123`
134+
135135
### 📱 Advanced Features
136136

137137
<details>

docs/readme/VI-VN_README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -89,27 +89,15 @@ Trong trình mô phỏng, mỗi tu sĩ đều là một Agent độc lập, có
8989

9090
### Cách Được Khuyến Nghị
9191

92-
- **Nếu chỉ muốn trải nghiệm ngay**: Ưu tiên dùng Docker để khởi động nhanh nhất.
9392
- **Nếu muốn sửa code hoặc debug**: Dùng cách chạy từ mã nguồn, đồng thời chuẩn bị Python `3.10+`, Node.js `18+` và một dịch vụ mô hình khả dụng.
93+
- **Nếu chỉ muốn trải nghiệm ngay**: Ưu tiên dùng Docker để triển khai một lệnh.
9494

9595
### Lưu Ý Khi Khởi Chạy Lần Đầu
9696

97-
-dùng Docker hay chạy từ mã nguồn, sau khi vào game lần đầu bạn vẫn cần vào trang cài đặt để cấu hình một preset mô hình khả dụng, như DeepSeek hoặc Ollama, rồi mới bắt đầu ván mới.
97+
- Dù chạy từ mã nguồn hay Docker, sau khi vào game lần đầu bạn vẫn cần vào trang cài đặt để cấu hình một preset mô hình khả dụng, như DeepSeek hoặc Ollama, rồi mới bắt đầu ván mới.
9898
- Ở chế độ phát triển, frontend thường sẽ tự mở. Nếu không tự mở, hãy truy cập vào địa chỉ frontend xuất hiện trong log khởi động.
9999

100-
### Cách 1: Docker Một Lệnh (Khuyến Nghị)
101-
102-
Không cần tự cấu hình môi trường, chỉ cần chạy:
103-
104-
```bash
105-
git clone https://github.com/4thfever/cultivation-world-simulator.git
106-
cd cultivation-world-simulator
107-
docker-compose up -d --build
108-
```
109-
110-
Truy cập frontend: `http://localhost:8123`
111-
112-
### Cách 2: Chạy Từ Mã Nguồn (Chế Độ Phát Triển)
100+
### Cách 1: Chạy Từ Mã Nguồn (Chế Độ Phát Triển, Khuyến Nghị)
113101

114102
Phù hợp cho nhà phát triển cần sửa code hoặc debug.
115103

@@ -131,6 +119,18 @@ Phù hợp cho nhà phát triển cần sửa code hoặc debug.
131119
3. **Mở frontend**
132120
Chế độ phát triển sẽ tự khởi chạy frontend dev server. Hãy mở địa chỉ frontend hiện trong log khởi động, thông thường là `http://localhost:5173`.
133121

122+
### Cách 2: Docker Một Lệnh
123+
124+
Không cần tự cấu hình môi trường, chỉ cần chạy:
125+
126+
```bash
127+
git clone https://github.com/4thfever/cultivation-world-simulator.git
128+
cd cultivation-world-simulator
129+
docker-compose up -d --build
130+
```
131+
132+
Truy cập frontend: `http://localhost:8123`
133+
134134
### 📱 Tính Năng Nâng Cao
135135

136136
<details>

docs/readme/ZH-TW_README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -90,27 +90,15 @@
9090

9191
### 推薦方式
9292

93-
- **想直接體驗**:優先使用 Docker 一鍵部署。
9493
- **想改程式碼或除錯**:使用原始碼部署,並準備 Python `3.10+`、Node.js `18+` 和可用的模型服務。
94+
- **想直接體驗**:優先使用 Docker 一鍵部署。
9595

9696
### 首次啟動說明
9797

98-
- 無論使用 Docker 還是原始碼開發,第一次進入後都需要先在設定頁配置可用的模型預設(如 DeepSeek / Ollama),再開始新遊戲。
98+
- 無論使用原始碼還是 Docker,第一次進入後都需要先在設定頁配置可用的模型預設(如 DeepSeek / Ollama),再開始新遊戲。
9999
- 開發模式下,前端頁面通常會自動打開;如果沒有自動打開,請訪問啟動日誌中顯示的前端地址。
100100

101-
### 方式一:Docker 一鍵部署(推薦)
102-
103-
無需配置環境,直接運行即可:
104-
105-
```bash
106-
git clone https://github.com/4thfever/cultivation-world-simulator.git
107-
cd cultivation-world-simulator
108-
docker-compose up -d --build
109-
```
110-
111-
訪問前端:`http://localhost:8123`
112-
113-
### 方式二:源碼部署(開發模式)
101+
### 方式一:源碼部署(開發模式,推薦)
114102

115103
適合需要修改程式碼或調試的開發者。
116104

@@ -132,6 +120,18 @@ docker-compose up -d --build
132120
3. **訪問前端**
133121
開發模式會自動拉起前端開發伺服器,請訪問啟動日誌中顯示的前端地址,通常為 `http://localhost:5173`
134122

123+
### 方式二:Docker 一鍵部署
124+
125+
無需配置環境,直接運行即可:
126+
127+
```bash
128+
git clone https://github.com/4thfever/cultivation-world-simulator.git
129+
cd cultivation-world-simulator
130+
docker-compose up -d --build
131+
```
132+
133+
訪問前端:`http://localhost:8123`
134+
135135
### 📱 高級功能
136136

137137
<details>

0 commit comments

Comments
 (0)