Skip to content

Commit

Permalink
ohter: update build and demo document
Browse files Browse the repository at this point in the history
  • Loading branch information
gezhaoyou committed Dec 18, 2024
1 parent 47cfebb commit 4bcff57
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 28 deletions.
35 changes: 16 additions & 19 deletions docs/docs/en/guide/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Execute the following commands at the root directory of the project.
**Generate Project**
::: code-group
```bash [Arm64]
cmake -G Xcode -B build -S src -DCMAKE_TOOLCHAIN_FILE=../toolchain/ios.toolchain.cmake -DPLATFORM=OS64
cmake -G Xcode -B build -S src -DCMAKE_TOOLCHAIN_FILE=../toolchain/ios.toolchain.cmake -DPLATFORM=OS64 -DCMAKE_BUILD_TYPE=Release
```
:::

Expand Down Expand Up @@ -52,7 +52,7 @@ Execute the following commands at the root directory of the project.
**Generate Project**
::: code-group
```bash [Apple Silicon]
cmake -G Xcode -B build -S src -DCMAKE_TOOLCHAIN_FILE=../toolchain/ios.toolchain.cmake -DPLATFORM=MAC_ARM64
cmake -G Xcode -B build -S src -DCMAKE_TOOLCHAIN_FILE=../toolchain/ios.toolchain.cmake -DPLATFORM=MAC_ARM64 -DCMAKE_BUILD_TYPE=Release
```
```bash [Intel]
cmake -G Xcode -B build -S src -DCMAKE_TOOLCHAIN_FILE=../toolchain/ios.toolchain.cmake -DPLATFORM=MAC
Expand Down Expand Up @@ -120,29 +120,23 @@ Compiling on Windows requires the installation of CMake and MinGW64.

**Generate Project**

```bash
# Generate project
cmake -G "MinGW Makefiles" -B build -S src
```
::: code-group

```bash [Release]
cmake --build build -DCMAKE_BUILD_TYPE=Release
cmake -G "MinGW Makefiles" -B build -S src -DCMAKE_BUILD_TYPE=Release
```

```bash [Debug]
cmake --build build -DCMAKE_BUILD_TYPE=Debug
cmake -G "MinGW Makefiles" -B build -S src -DCMAKE_BUILD_TYPE=Debug
```
:::

**Compile**
::: code-group

```bash [Release]
cmake --build build -DCMAKE_BUILD_TYPE=Release
cmake --build build --config Release
```

```bash [Debug]
cmake --build build -DCMAKE_BUILD_TYPE=Debug
cmake --build build --config Debug
```
:::

Expand All @@ -168,20 +162,23 @@ sudo apt-get install mesa-utils libglu1-mesa-dev freeglut3-dev mesa-common-dev l
```

**Generate Project**
```bash
# Generate project
cmake -B build -S src
```bash [Release]
cmake -B build -S src -DCMAKE_BUILD_TYPE=Release
```

```bash [Debug]
cmake -B build -S src -DCMAKE_BUILD_TYPE=Debug
```
:::

**Compile**
::: code-group

```bash [Release]
cmake --build build -DCMAKE_BUILD_TYPE=Release
cmake --build build --config Release
```

```bash [Debug]
cmake --build build -DCMAKE_BUILD_TYPE=Debug
cmake --build build --config Debug
```
:::

Expand Down
8 changes: 4 additions & 4 deletions docs/docs/en/guide/demo.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,11 +87,11 @@ It includes the demo and the gpupixel module. The invocation logic is in `MainAc
::: code-group
```bash [Windows]
# Generate project
cmake -G "MinGW Makefiles" -B examples/build -S examples
cmake -G "MinGW Makefiles" -B examples/build -S examples -DCMAKE_BUILD_TYPE=Release
```
```bash [Linux]
# Generate project
cmake -G "Unix Makefiles" -B examples/build -S examples
cmake -G "Unix Makefiles" -B examples/build -S examples -DCMAKE_BUILD_TYPE=Release
```
:::

Expand All @@ -100,12 +100,12 @@ cmake -G "Unix Makefiles" -B examples/build -S examples

```bash [Release]
# Build
cmake --build build -DCMAKE_BUILD_TYPE=Release
cmake --build build --config Release
```

```bash [Debug]
# Build
cmake --build build -DCMAKE_BUILD_TYPE=Debug
cmake --build build --config Debug
```
:::

Expand Down
15 changes: 10 additions & 5 deletions docs/docs/zh/guide/demo.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,11 +87,11 @@ examples
::: code-group
```bash [Windows]
# Generate project
cmake -G "MinGW Makefiles" -B examples/build -S examples
cmake -G "MinGW Makefiles" -B examples/build -S examples -DCMAKE_BUILD_TYPE=Release
```
```bash [Linux]
# Generate project
cmake -B examples/build -S examples
cmake -B examples/build -S examples -DCMAKE_BUILD_TYPE=Release
```
:::

Expand All @@ -100,12 +100,12 @@ cmake -B examples/build -S examples

```bash [Release]
# Build
cmake --build build -DCMAKE_BUILD_TYPE=Release
cmake --build examples/build --config Release
```

```bash [Debug]
# Build
cmake --build build -DCMAKE_BUILD_TYPE=Debug
cmake --build examples/build --config Debug
```
:::

Expand All @@ -119,6 +119,11 @@ Demo运行起来后,按键盘调节美颜程度,具体如下:


## Web

```bash
// not support yet
```

## Python
``` bash
// not support yet
```

0 comments on commit 4bcff57

Please sign in to comment.