Skip to content

Commit d4e23c8

Browse files
committed
docs: update README
1 parent 3d7ad20 commit d4e23c8

File tree

2 files changed

+62
-16
lines changed

2 files changed

+62
-16
lines changed

README.md

Lines changed: 34 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@
7979

8080
<br>
8181

82-
## Update (2022-2024 v6.x)
82+
## Update (2022-2025 v7.x)
8383

8484
### Features
8585

@@ -119,26 +119,52 @@ In addition, the source code summary is accompanied by detailed code comments fo
119119

120120
## Build
121121

122-
1. Install Qt (Qt >= 5.12.11)and other dependencies
123-
124-
For Debian and Ubuntu, run:
125-
122+
> This project supports both Qt 5 and Qt 6 builds.
123+
>
124+
> For more project list: https://product.xmuli.tech
125+
126+
127+
128+
- Environment: This project compiles successfully with both Qt 5.15.2 and 6.8.3 LTS versions. Tested minimum build version is Qt 5.12; lower versions are unverified.
129+
- IDE: We recommend using Qt Creator directly to open CMakeLists.txt for building.
130+
- Other: You may also convert CMake to .sln manually and build using Visual Studio 2022.
131+
132+
133+
134+
### Windows Build
135+
136+
1. Install Qt (recommended: Qt 5.15 or Qt 6.8 LTS)
137+
2. Open CMakeLists.txt directly in the Qt Creator IDE
138+
3. Click Build > Compile in the bottom-left corner
139+
4. You should see it run successfully. Enjoy~
140+
141+
142+
143+
### Linux / Mac Build
144+
145+
1. Using Debian and Ubuntu as examples, install Qt (recommended: Qt 5.15 or Qt 6.8 LTS) Execute:
146+
126147
```bash
127148
$ sudo apt install cmake qtbase5-dev qt5-default libqt5svg5-dev qtmultimedia5-dev qttools5-dev libqt5x11extras5-dev
128149
```
150+
129151

130-
2. Run the command::
152+
153+
2. Run commands:
131154

132155
```bash
133156
$ git clone https://github.com/XMuli/ChineseChess.git
134157
$ cd ChineseChess
135158
$ mkdir build && cd build
136-
$ cmake .. # or qmake
159+
$ cmake ..
137160
$ make
138161
```
139162

163+
3. Alternatively, you can skip Step 2 and directly use Qt Creator for compilation and execution, which is more convenient.
164+
165+
140166

141-
Or you can skip the second step and use Qt Creator to compile and run.
167+
$ sudo apt install cmake qtbase5-dev qt5-default libqt5svg5-dev qtmultimedia5-dev qttools5-dev libqt5x11extras5-dev
142168

143169
<br>
144170

README.zh_CN.md

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@
7676

7777
<br>
7878

79-
## 更新(2022-2024 v6.x)
79+
## 更新(2022-2025 v7.x)
8080

8181
### 功能
8282

@@ -110,26 +110,46 @@
110110

111111
## 构建
112112

113-
1. 安装 Qt (Qt >= 5.12.11)和其他依赖
113+
> 本项目构建同时支持 QT 5 和 QT 6,更多项目集: https://product.xmuli.tech/
114+
115+
116+
117+
- **环境:** 本工程可以用 Qt 5.15.2 和 6.8.3 LTS 版本同时可编译通过;实测试最低构建 Qt 5.12,更低版本未验证
118+
- IDE: 推荐直接只用 Qt Creator 打开 CMakeLists.txt 进行构建
119+
- Other: 也可以自行 CMake 转 .sln 使用 Visual Studio 2022 构建
120+
121+
122+
123+
### Windows 构建
124+
125+
1. 安装 Qt (推荐 Qt 5.15 或者 Qt 6.8 LTS)
126+
2. 直接使用 Qt Crator IDE 打开 CMakeLists.txt
127+
3. 点击左下角构建-编译
128+
4. 可以看到成功运行,Enjoy~
129+
130+
131+
132+
### Linux / Mac 构建
133+
134+
1. 以 Debian 和 Ubuntu 为例,安装 Qt (推荐 Qt 5.15 或者 Qt 6.8 LTS)执行:
114135

115-
以 Debian 和 Ubuntu 为例,执行:
116-
117136
```bash
118137
$ sudo apt install cmake qtbase5-dev qt5-default libqt5svg5-dev qtmultimedia5-dev qttools5-dev libqt5x11extras5-dev
119138
```
120-
121-
2. 运行命令:
139+
140+
2. 运行命令
122141

123142
```bash
124143
$ git clone https://github.com/XMuli/ChineseChess.git
125144
$ cd ChineseChess
126145
$ mkdir build && cd build
127-
$ cmake .. # or qmake
146+
$ cmake ..
128147
$ make
129148
```
130149

150+
3. 或者,你可以跳过第 2 步,同样直接使用 Qt Creator 进行编译和运行,更加方便。
151+
131152

132-
或者,你可以跳过第 2 步,直接使用 Qt Creator 进行编译和运行。
133153

134154
<br>
135155

0 commit comments

Comments
 (0)