From 9ee049c37753bc07a0fa10be36166d54c7095893 Mon Sep 17 00:00:00 2001 From: bridge Date: Sun, 1 Feb 2026 13:38:19 +0800 Subject: [PATCH] docs: enhance README files with detailed Docker setup and application access instructions - Added a new section in EN_README.md for Docker Compose usage, outlining the steps to clone the repository and start the service. - Updated README.md to include application access details for both frontend and backend after installation. - Improved clarity and organization of setup instructions in both README files. --- EN_README.md | 23 +++++++++++++++++++++++ README.md | 12 +++++++----- 2 files changed, 30 insertions(+), 5 deletions(-) diff --git a/EN_README.md b/EN_README.md index 2ad0f44..edbdd0d 100644 --- a/EN_README.md +++ b/EN_README.md @@ -105,6 +105,24 @@ You can also join the QQ group for discussion: 1071821688. Verification answer: ## 🚀 Usage ### ⚙️ Run Steps + +#### Option 1: Docker Compose (Recommended) + +If you have Docker installed, this is the easiest way: + +1. **Clone the repo** + ```bash + git clone https://github.com/AI-Cultivation/cultivation-world-simulator.git + cd cultivation-world-simulator + ``` + +2. **Start Service (Auto build & run)** + ```bash + docker-compose up -d --build + ``` + +#### Option 2: Manual Installation + 1. Clone the repo: ```bash git clone https://github.com/AI-Cultivation/cultivation-world-simulator.git @@ -146,6 +164,11 @@ You can also join the QQ group for discussion: 1071821688. Verification answer: ``` The browser will automatically open the web frontend. +### 🌐 Access Application + +Frontend: `http://localhost:8123` +Backend API: `http://localhost:8002` + ## 📊 Project Status diff --git a/README.md b/README.md index 2a1a019..96b5ce2 100644 --- a/README.md +++ b/README.md @@ -124,11 +124,6 @@ docker-compose up -d --build ``` -3. **访问应用** - - 前端:`http://localhost:8123` - 后端 API:`http://localhost:8002` - #### 方式二:手动安装运行 1. 克隆项目到本地: @@ -171,6 +166,13 @@ ``` 浏览器会自动打开网页前端。 +### 🌐 访问应用 + +无论使用哪种方式运行,启动后都可以通过以下地址访问: + +前端:`http://localhost:8123` +后端 API:`http://localhost:8002` + ## 📊 项目状态