Skip to content

docs: document xmake and Mingw-w64 dependency for Windows setup #74

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lczllx wants to merge 1 commit into
base: main
Choose a base branch
from
+32 −0
Open

docs: document xmake and Mingw-w64 dependency for Windows setup #74

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,17 @@ cd d2mcpp
d2x checker
```

> On Windows, `d2x checker` requires [xmake](https://xmake.io/#/getting_started) and a GCC toolchain (Mingw-w64). Install both first:
>
> ```
> winget install xmake # or: scoop install xmake
> winget install MSYS2.MSYS2 # then in MSYS2: pacman -S mingw-w64-x86_64-gcc
> ```
>
> Then configure xmake to use the GCC toolchain: `xmake f --toolchain=mingw`

**👉 [more details...]

**👉 [more details...](https://mcpp-community.github.io/d2mcpp/base/chapter_1.html)**

## Community
Expand Down
11 changes: 11 additions & 0 deletions README.zh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,17 @@ cd d2mcpp
d2x checker
```

> Windows 上 `d2x checker` 依赖 [xmake](https://xmake.io/#/getting_started) 和 GCC 工具链 (Mingw-w64)，需先安装两者:
>
> ```
> winget install xmake # 或: scoop install xmake
> winget install MSYS2.MSYS2 # 然后在 MSYS2 中: pacman -S mingw-w64-x86_64-gcc
> ```
>
> 然后配置 xmake 使用 GCC 工具链: `xmake f --toolchain=mingw`

**👉 [更多细节...]

**👉 [更多细节...](https://mcpp-community.github.io/d2mcpp/base/chapter_1.html)**

## 社区
Expand Down
10 changes: 10 additions & 0 deletions book/src/base/chapter_1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,18 @@ Invoke-Expression (Invoke-Webrequest 'https://raw.githubusercontent.com/openxlin

```bash
d2x install d2mcpp
cd d2mcpp
```

> Windows 上需额外安装 [xmake](https://xmake.io/#/getting_started) 和 Mingw-w64 工具链:
>
> ```
> winget install xmake # 或: scoop install xmake
> winget install MSYS2.MSYS2 # 然后在 MSYS2 中: pacman -S mingw-w64-x86_64-gcc
> ```
>
> 然后配置 xmake 使用 GCC 工具链: `xmake f --toolchain=mingw`

### 本地电子书

> 可以在项目目录执行`d2x book`命令, 打开本地文档(包含使用说明和电子书)
Expand Down