Skip to content

Commit

Permalink
Update Build/README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
egorodet authored Aug 17, 2023
1 parent 05312a5 commit 5bb190e
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions Build/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,16 +79,16 @@ cmake -S . -B %OUTPUT_DIR%\Build -G "Visual Studio 17 2022" -A x64 -DCMAKE_INSTA
cmake --build %OUTPUT_DIR%\Build --config Release --target install
```

[Methane Graphics Core](/Modules/Graphics/Core) is built using **DirectX 12** graphics API by default on Windows.
[Methane Graphics RHI](https://github.com/MethanePowered/MethaneKit/tree/master/Modules/Graphics/RHI) is built using **DirectX 12** graphics API by default on Windows.
Vulkan graphics API can be used instead by adding cmake generator option `-DMETHANE_GFX_VULKAN_ENABLED:BOOL=ON`.
Auxiliary build script [Build/Windows/Build.bat](/Build/Windows/Build.bat) can make it more simple for you:

```console
./Build/Windows/Build.bat [--vs2022] [--win32] [--debug] [--vulkan] [--graphviz] [--analyze SONAR_TOKEN]
./Build/Windows/Build.bat [--vs2019] [--win32] [--debug] [--vulkan] [--graphviz] [--analyze SONAR_TOKEN]
```

Alternatively root [CMakeLists.txt](/CMakeLists.txt) can be opened directly in Visual Studio or
[any other IDE with native CMake support](/README.md#development-environments) and [built using CMake presets](#cmake-presets).
any other IDE with native CMake support and [built using CMake presets](#cmake-presets).

Run built applications from the installation directory `Build\Output\VisualStudio\Win64-DX\Install\Apps`

Expand All @@ -102,15 +102,15 @@ cmake -S . -B $OUTPUT_DIR/Build -G "Unix Makefiles" -DCMAKE_INSTALL_PREFIX="$(pw
cmake --build $OUTPUT_DIR/Build --config Release --target install --parallel 8
```

[Methane Graphics Core](/Modules/Graphics/Core) is built using **Vulkan** graphics API on Linux.
[Methane Graphics RHI](https://github.com/MethanePowered/MethaneKit/tree/master/Modules/Graphics/Core) is built using **Vulkan** graphics API on Linux.
Auxiliary build script [Build/Unix/Build.sh](/Build/Unix/Build.sh) can make it more simple for you:

```console
./Build/Unix/Build.sh [--debug] [--graphviz] [--analyze SONAR_TOKEN]
```

Alternatively root [CMakeLists.txt](/CMakeLists.txt) can be opened directly in
[any IDE with native CMake support](/README.md#development-environments) and [built using CMake presets](#cmake-presets).
any IDE with native CMake support and [built using CMake presets](#cmake-presets).

Run built applications from the installation directory `Build/Output/Linux/Install/Apps`.
Note that in Ubuntu Linux even GUI applications should be started from "Terminal" app,
Expand All @@ -137,12 +137,12 @@ Auxiliary build script [Build/Unix/Build.sh](/Build/Unix/Build.sh) can make it m
```

Alternatively root [CMakeLists.txt](/CMakeLists.txt) can be opened directly in Visual Studio or
[any other IDE with native CMake support](/README.md#development-environments) and [built using CMake presets](#cmake-presets).
any other IDE with native CMake support and [built using CMake presets](#cmake-presets).

[Methane Graphics Core](/Modules/Graphics/Core) is built using **Metal** graphics API on MacOS by default.
[Methane Graphics RHI](https://github.com/MethanePowered/MethaneKit/tree/master/Modules/Graphics/Core) is built using **Metal** graphics API on MacOS by default.
Vulkan graphics API can be used instead by adding cmake generator option `-DMETHANE_GFX_VULKAN_ENABLED:BOOL=ON` or
by running `Build/Unix/Build.sh --vulkan`, but it requires Vulkan SDK installation with MoltenVK driver implementation
on top of Metal, which is not currently supporting all extensions required by Methane Kit.
on top of Metal.

Run built applications from the installation directory `Build/Output/XCode/Install/Apps`.

Expand Down

0 comments on commit 5bb190e

Please sign in to comment.