@@ -135,8 +135,10 @@ Master repository includes the following submodules:
135135* [ Tools] ( https://github.com/DiligentGraphics/DiligentTools ) submodule contains
136136 [ texture loading library] ( https://github.com/DiligentGraphics/DiligentTools/tree/master/TextureLoader ) ,
137137 [ asset loading library] ( https://github.com/DiligentGraphics/DiligentTools/blob/master/AssetLoader ) ,
138- [ dear imgui implementation] ( https://github.com/DiligentGraphics/DiligentTools/blob/master/Imgui ) , and
139- [ native application implementation] ( https://github.com/DiligentGraphics/DiligentTools/blob/master/NativeApp ) .
138+ [ dear imgui implementation] ( https://github.com/DiligentGraphics/DiligentTools/blob/master/Imgui ) ,
139+ [ native application implementation] ( https://github.com/DiligentGraphics/DiligentTools/blob/master/NativeApp ) ,
140+ [ Diligent render state notation parser] ( https://github.com/DiligentGraphics/DiligentTools/tree/master/RenderStateNotation ) and
141+ [ offline render state packaging tool] ( https://github.com/DiligentGraphics/DiligentTools/tree/master/RenderStatePackager ) .
140142* [ DiligentFX] ( https://github.com/DiligentGraphics/DiligentFX ) is a high-level rendering framework that implements
141143 various rendering components. The module depends on Core and Tools modules.
142144* [ Samples] ( https://github.com/DiligentGraphics/DiligentSamples ) submodule contains tutorials and sample applications
@@ -182,7 +184,7 @@ cmake -S . -B ./build/MinGW -D CMAKE_BUILD_TYPE=Release -G "MinGW Makefiles"
182184
183185:warning : In current implementation, full path to cmake build folder ** must not contain white spaces** .
184186
185- To enable Vulkan validation layers, you will need to download [ Vulkan SDK] ( https://www.lunarg.com/vulkan-sdk/ ) and add environemt
187+ To enable Vulkan validation layers, you will need to download the [ Vulkan SDK] ( https://www.lunarg.com/vulkan-sdk/ ) and add environemt
186188variable ` VK_LAYER_PATH ` that contains the path to the * Bin* directory in VulkanSDK installation folder.
187189
188190Open * DiligentEngine.sln* file in * build/Win64* folder, select configuration and build the engine. Set the desired project
@@ -273,13 +275,13 @@ To configure Vulkan you will also need to:
273275To generate make files for debug configuration, run the following CMake command from the engine's root folder:
274276
275277```
276- cmake -S . -B ./build/Linux64 -G "Unix Makefiles" -DCMAKE_BUILD_TYPE="Debug"
278+ cmake -S . -B ./build -G "Unix Makefiles" -DCMAKE_BUILD_TYPE="Debug"
277279```
278280
279281To build the engine, run the following command:
280282
281283```
282- cmake --build ./build/Linux64
284+ cmake --build ./build
283285```
284286
285287The engine's root folder contains [ Visual Studio Code] ( https://code.visualstudio.com/ ) settings files that configure
@@ -314,8 +316,7 @@ By default, applications will run in OpenGLES mode. To run them in Vulkan mode,
314316<a name =" build_and_run_macos " ></a >
315317## MacOS
316318
317- After you clone the repo, run the following command from the engine's root folder to generate Xcode project
318- (you need to have [ CMake] ( https://cmake.org/ ) installed on the system):
319+ After you clone the repo, run the following command from the engine's root folder to generate Xcode project:
319320
320321```
321322cmake -S . -B ./build/MacOS -G "Xcode"
@@ -387,7 +388,7 @@ you will need to set appropriate development team in the project settings.
387388
388389### Configuring Vulkan Build Environment
389390
390- To enable Vulkan on iOS, download and install [ VulkanSDK] ( https://vulkan.lunarg.com/sdk/home#mac ) . There is no Vulkan loader
391+ To enable Vulkan on iOS, download and install the [ VulkanSDK] ( https://vulkan.lunarg.com/sdk/home#mac ) . There is no Vulkan loader
391392on iOS, and Diligent Engine links directly with MoltenVK XCFramework (see
392393[ MoltenVk install guide] ( https://github.com/KhronosGroup/MoltenVK/blob/master/Docs/MoltenVK_Runtime_UserGuide.md#install-moltenvk-as-a-universal-xcframework ) )
393394that implements Vulkan on Metal. To enable Vulkan in Diligent Engine on iOS, specify the path to Vulkan SDK
@@ -546,8 +547,6 @@ For example, for Windows platform, the list of libraries your project will need
546547DiligentCore.lib glslang.lib HLSL.lib OGLCompiler.lib OSDependent.lib spirv-cross-core.lib SPIRV.lib SPIRV-Tools-opt.lib SPIRV-Tools.lib glew-static.lib GenericCodeGen.lib MachineIndependent.lib dxgi.lib d3d11.lib d3d12.lib d3dcompiler.lib opengl32.lib
547548```
548549
549- Vulkan libraries can be found in [ DiligentCore/ThirdParty/vulkan/libs] ( https://github.com/DiligentGraphics/DiligentCore/tree/master/ThirdParty/vulkan/libs ) directory.
550-
551550Diligent Engine headers require one of the following platform macros to be defined as ` 1 ` :
552551` PLATFORM_WIN32 ` , ` PLATFORM_UNIVERSAL_WINDOWS ` , ` PLATFORM_ANDROID ` , ` PLATFORM_LINUX ` , ` PLATFORM_MACOS ` , ` PLATFORM_IOS ` .
553552
@@ -929,7 +928,7 @@ In submitting any content to this repository,
929928and you agree that the content is free of any Intellectual Property claims and you have the right to license it under those terms.
930929
931930Diligent Engine uses [ clang-format] ( https://clang.llvm.org/docs/ClangFormat.html ) to ensure
932- consistent source code style throughout the code base. The format is validated by appveyor and travis
931+ consistent source code style throughout the code base. The format is validated by CI
933932for each commit and pull request, and the build will fail if any code formatting issue is found. Please refer
934933to [ this page] ( https://github.com/DiligentGraphics/DiligentCore/blob/master/doc/code_formatting.md ) for instructions
935934on how to set up clang-format and automatic code formatting.
0 commit comments