From c7ead98e4557b148fe7f3e261abb78a512b7bb5a Mon Sep 17 00:00:00 2001
From: mklefrancois <38076163+mklefrancois@users.noreply.github.com>
Date: Wed, 1 Apr 2020 14:35:18 +0200
Subject: [PATCH] Fixing documentation
---
docs/setup.md.html | 29 ++++++++++-------
...rayquery.htm => vkrt_tuto_rayquery.md.htm} | 0
docs/vkrt_tutorial.md.htm | 32 +++++++++++--------
3 files changed, 36 insertions(+), 25 deletions(-)
rename docs/{vkrt_tuto_rayquery.htm => vkrt_tuto_rayquery.md.htm} (100%)
diff --git a/docs/setup.md.html b/docs/setup.md.html
index 6ebbeb7..0b7c19f 100644
--- a/docs/setup.md.html
+++ b/docs/setup.md.html
@@ -2,8 +2,20 @@
# Environment Setup
-To get support for `VK_KHR_ray_tracing`, please install an [Vulkan NVIDIA driver](https://developer.nvidia.com/vulkan-driver)
-with version 442.81 or later, and the [Vulkan SDK](http://vulkan.lunarg.com/sdk/home) version 1.2.136.0 or later.
+## Beta Installation
+
+If you are in the Beta period, install and compile all of the following
+
+* Latest driver: https://developer.nvidia.com/vulkan-driver
+* Latest Vulkan headers: https://github.com/KhronosGroup/Vulkan-Headers
+* Latest glslangValidator: https://github.com/KhronosGroup/glslang
+
+!!! Warning Beta
+ Copy/replace `glslangValidator.exe` in the VulkanSDK bin directory.
+ Ex: `C:\VulkanSDK\1.2.131.1\Bin`
+
+
+## Structure
This tutorial is a modification of [`ray_tracing__simple`](https://github.com/nvpro-samples/vk_raytracing_tutorial/tree/master/ray_tracing__simple), which is the result of the ray tracing tutorial.
All following instructions are based on the modification of this project.
@@ -27,25 +39,18 @@ The directory structure should be looking like:
* | +-- 📂 ray_tracing__simple (<-- Start here)
* | |
* | +-- 📂 ray_tracing_...
+* | |
* | â‹®
* |
* â‹®
**********************************************************
-
!!! Warning
**Run CMake** in vk_raytracing_tutorial.
-## Beta Installation
-
-If you are in the Beta period
-
-* Latest driver: https://developer.nvidia.com/vulkan-driver
-* Latest Vulkan headers: https://github.com/KhronosGroup/Vulkan-Headers
-* When running CMake, modify VULKAN > VULKAN_HEADERS_OVERRIDE_INCLUDE_DIR to the path to beta vulkan headers.
- Ex. under C:\Vulkan\Beta, copy the folder vulkan\ which contains all headers.
- VULKAN_HEADERS_OVERRIDE_INCLUDE_DIR should point to C:\Vulkan\Beta
+!!! Warning Beta
+ Modify `VULKAN > VULKAN_HEADERS_OVERRIDE_INCLUDE_DIR` to the path to beta vulkan headers.
diff --git a/docs/vkrt_tuto_rayquery.htm b/docs/vkrt_tuto_rayquery.md.htm
similarity index 100%
rename from docs/vkrt_tuto_rayquery.htm
rename to docs/vkrt_tuto_rayquery.md.htm
diff --git a/docs/vkrt_tutorial.md.htm b/docs/vkrt_tutorial.md.htm
index c0413ac..0dd2677 100644
--- a/docs/vkrt_tutorial.md.htm
+++ b/docs/vkrt_tutorial.md.htm
@@ -33,10 +33,23 @@ verbosity and its potential for errors.
# Environment Setup
-To get support for `VK_KHR_ray_tracing`, please install an [NVIDIA driver](http://www.nvidia.com/Download/index.aspx?lang=en-us)
-with version 440.97 or later, and the [Vulkan SDK](http://vulkan.lunarg.com/sdk/home) version 1.1.126.0 or later.
-The tutorial is a modification of [`ray_tracing__before`](https://github.com/nvpro-samples/vk_raytracing_tutorial/tree/master/ray_tracing__before), which loads are render OBJ scenes with Vulkan rasterizer.
+## Beta Installation
+
+If you are in the Beta period, install and compile all of the following
+
+* Latest driver: https://developer.nvidia.com/vulkan-driver
+* Latest Vulkan headers: https://github.com/KhronosGroup/Vulkan-Headers
+* Latest glslangValidator: https://github.com/KhronosGroup/glslang
+
+!!! Warning Beta
+ Copy/replace `glslangValidator.exe` in the VulkanSDK bin directory.
+ Ex: `C:\VulkanSDK\1.2.131.1\Bin`
+
+
+## Structure
+
+This tutorial is a modification of [`ray_tracing__before`](https://github.com/nvpro-samples/vk_raytracing_tutorial/tree/master/ray_tracing__before), which loads are render OBJ scenes with Vulkan rasterizer.
All following instructions are based on the modification of this project.
The directory `ray_tracing__simple` is the end result of this tutorial.
@@ -67,21 +80,14 @@ The directory structure should be looking like:
!!! Warning
**Run CMake** in vk_raytracing_tutorial.
+!!! Warning Beta
+ Modify `VULKAN > VULKAN_HEADERS_OVERRIDE_INCLUDE_DIR` to the path to beta vulkan headers.
+
The starting project is a simple framework allowing us to load OBJ files and rasterize them
using Vulkan.
![First Run](Images/resultRasterCube.png width="350px")
-## Beta Installation
-
-If you are in the Beta period
-
-* Latest driver: https://developer.nvidia.com/vulkan-driver
-* Latest Vulkan headers: https://github.com/KhronosGroup/Vulkan-Headers
-* When running CMake, modify VULKAN > VULKAN_HEADERS_OVERRIDE_INCLUDE_DIR to the path to beta vulkan headers.
- Ex. under C:\Vulkan\Beta, copy the folder vulkan\ which contains all headers.
- VULKAN_HEADERS_OVERRIDE_INCLUDE_DIR should point to C:\Vulkan\Beta
-
# Ray Tracing Setup