Skip to content

Commit 42a7169

Browse files
authored
docs(avalonia): update environment setup and build instructions (#4)
1 parent 3e2017d commit 42a7169

File tree

2 files changed

+12
-6
lines changed

2 files changed

+12
-6
lines changed

docs/en-us/articles/avalonia/introduction.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,12 @@
1515
winget install zig.zig
1616
```
1717

18+
> [!WARNING]
19+
> It is not recommended to add `clang` to the environment variables, as it may conflict with the build process.
20+
1821
* [LLVM](https://releases.llvm.org/download.html) is needed for the compilation process that uses `llvm-objcopy.exe`, ensure it exists in your environment variables
1922

20-
* .NET 8.0 SDK and .NET 9.0 SDK
23+
* .NET 9.0 SDK or greater
2124

2225
* Latest version of DevEco Studio
2326

@@ -27,10 +30,10 @@ winget install zig.zig
2730

2831
## Build and Run
2932

30-
* Pull the latest code from [OpenHarmony.Avalonia](https://github.com/OpenHarmony-NET/OpenHarmony.Avalonia)
33+
* Pull the latest code from [OpenHarmony.Avalonia](https://github.com/OpenHarmony-NET/OpenHarmony.Avalonia), ensure to clone with the `--recursive` option to include submodules
3134

3235
```shell
33-
git clone https://github.com/OpenHarmony-NET/OpenHarmony.Avalonia.git --recursive
36+
git clone https://github.com/OpenHarmony-NET/OpenHarmony.Avalonia.git --recursive # Include submodules
3437
```
3538

3639
* Enter the project directory `OpenHarmony.Avalonia`

docs/zh-cn/articles/avalonia/introduction.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,12 @@
1515
winget install zig.zig
1616
```
1717

18+
> [!WARNING]
19+
> 不建议将 `clang` 添加到环境变量中,会与构建过程冲突
20+
1821
* [LLVM](https://releases.llvm.org/download.html) 编译过程中需要使用 `llvm-objcopy.exe`,需要保证环境变量中存在
1922

20-
* .NET 8.0 SDK 和 .NET 9.0 SDK
23+
* .NET 9.0 SDK 或更高版本
2124

2225
* DevEco Studio 最新版本
2326

@@ -27,10 +30,10 @@ winget install zig.zig
2730

2831
## 构建运行
2932

30-
* 拉取 [OpenHarmony.Avalonia](https://github.com/OpenHarmony-NET/OpenHarmony.Avalonia) 的最新代码
33+
* 拉取 [OpenHarmony.Avalonia](https://github.com/OpenHarmony-NET/OpenHarmony.Avalonia) 的最新代码,请确保使用 `--recursive` 参数来克隆子模块
3134

3235
```shell
33-
git clone https://github.com/OpenHarmony-NET/OpenHarmony.Avalonia.git --recursive
36+
git clone https://github.com/OpenHarmony-NET/OpenHarmony.Avalonia.git --recursive # 包括子模块
3437
```
3538

3639
* 进入项目目录`OpenHarmony.Avalonia`

0 commit comments

Comments
 (0)