Skip to content

Commit 95c04cf

Browse files
committed
docs: update README
Signed-off-by: Dylan <[email protected]>
1 parent 2e78ffb commit 95c04cf

File tree

2 files changed

+19
-7
lines changed

2 files changed

+19
-7
lines changed

.github/workflows/cmake.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ jobs:
4444

4545
- uses: actions/upload-artifact@v4
4646
with:
47-
name: PC_Demo_Setup
47+
name: PC_Demo_Setup_x64
4848
path: bin/NIM_Demo_Setup*.exe
4949
build-x86:
5050
runs-on: windows-2019
@@ -78,5 +78,5 @@ jobs:
7878

7979
- uses: actions/upload-artifact@v4
8080
with:
81-
name: PC_Demo_Setup
81+
name: PC_Demo_Setup_Win32
8282
path: bin/NIM_Demo_Setup*.exe

README.md

+17-5
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@
22

33
网易云信 PC IM Demo 是基于[网易云信 PC SDK](https://yunxin.163.com/im-sdk-demo) 制作的即时通讯示例程序,UI 库使用 [NIM Duilib](https://github.com/netease-im/NIM_Duilib_Framework) 制作
44

5-
![GitHub](https://img.shields.io/badge/license-MIT-green.svg)
6-
[![Actions Status](https://github.com/netease-im/NIM_PC_Demo/workflows/MSBuild/badge.svg)](https://github.com/netease-im/NIM_PC_Demo/actions)
5+
![GitHub](https://img.shields.io/badge/license-MIT-green.svg) | [![Actions Status](https://github.com/netease-im/NIM_PC_Demo/workflows/MSBuild/badge.svg)](https://github.com/netease-im/NIM_PC_Demo/actions)
76

87
## 预览
98

@@ -29,12 +28,23 @@ git clone https://github.com/netease-im/NIM_PC_Demo.git --depth 10
2928

3029
执行如下命令初始化 Debug 调试版本的项目:
3130

32-
> 首次初始化 Debug 或 Release 工程时会自动下载并编译依赖的三方库代码,这个过程可能相对较慢,请耐心等待。当您再次编译时,将不再重复下载和编译三方库代码而是使用上一次编译后的产物。
31+
> [!NOTE]
32+
> 首次初始化 Debug 或 Release 工程时会自动下载并编译依赖的三方库代码,这个过程可能相对较慢,请耐心等待。当您再次编译时,将不再重复下载和编译三方库代码而是使用上一次编译后的产物。
3333
3434
```bash
35+
# 生成 32 位 Debug 工程,如果您未指定 Visual Studio 版本将默认使用本机安装的最新版本
3536
cmake -Bbuild -AWin32 -DCMAKE_BUILD_TYPE=Debug
37+
38+
# 生成 64 位 Debug 工程
39+
cmake -Bbuild -Ax64 -DCMAKE_BUILD_TYPE=Debug
3640
```
3741

42+
> [!TIP]
43+
> Visual Studio 2017 以下版本工具链不支持使用 cmake -A 参数来指定目标产物架构,您可以使用如下命令分别生成 32 位和 64 位的工程
44+
>
45+
> `cmake -Bbuild -G "Visual Studio 15 2017" -DCMAKE_BUILD_TYPE=Debug`
46+
> `cmake -Bbuild -G "Visual Studio 15 2017 Win64" -DCMAKE_BUILD_TYPE=Debug`
47+
3848
您可以通过打开 build 目录下的 `nim_win_demo.sln` 来进行调试或通过 CMake 命令直接编译:
3949

4050
```bash
@@ -50,9 +60,11 @@ cmake -Bbuild -AWin32 -DCMAKE_BUILD_TYPE=Release
5060
cmake --build build --config Release
5161
```
5262

53-
> 所有产物均生成在项目根目录下的 bin 文件夹中,项目编译完成后您可以直接从 bin 目录下运行 nim_demo.exe 来启动 Demo
63+
> [!TIP]
64+
> 所有产物均生成在项目根目录下的 bin 文件夹中,项目编译完成后您可以直接从 bin 目录下运行 nim_demo.exe 来启动 Demo
5465
55-
> 需要注意的是,由于 Debug 和 Release 版本的依赖库文件都会拷贝到 bin 目录下,因此在切换 Debug 和 Release 版本时请使用 git clean -xdf 命令清理 bin 目录下的临时文件
66+
> [!IMPORTANT]
67+
> 需要注意的是,由于 Debug 和 Release 版本的依赖库文件都会拷贝到 bin 目录下,因此在切换 Debug 和 Release 版本时请使用 `git clean -xdf` 命令清理 bin 目录下的临时文件
5668
5769
### 制作安装包
5870

0 commit comments

Comments
 (0)