From 43a09d9ccec658134fcaf06c0e9cc973b1058535 Mon Sep 17 00:00:00 2001 From: Tobias Frisch <tfrisch@uni-koblenz.de> Date: Thu, 23 Jun 2022 23:48:52 +0200 Subject: [PATCH] Fixing wrong links in the README.md files Signed-off-by: Tobias Frisch <tfrisch@uni-koblenz.de> --- README.md | 11 +++-------- modules/algorithm/README.md | 2 +- modules/asset_loader/README.md | 2 +- modules/camera/README.md | 2 +- modules/effects/README.md | 2 +- modules/gui/README.md | 2 +- modules/material/README.md | 2 +- modules/meshlet/README.md | 2 +- modules/scene/README.md | 2 +- modules/shader_compiler/README.md | 2 +- modules/upscaling/README.md | 3 ++- 11 files changed, 14 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index fa0d833e..202672d0 100644 --- a/README.md +++ b/README.md @@ -11,8 +11,6 @@ More information about Git LFS [here](https://git-lfs.github.com/). ## Build - [](https://gitlab.uni-koblenz.de/vulkan2021/vkcv-framework/-/commits/develop) - Git submodules are used for libraries. To download the submodules either clone using `git clone --recurse-submodules` or after `git clone` use `git submodule init` and `git submodule update`. @@ -48,10 +46,7 @@ The following modules will be provided in this repository and they will automati ## Documentation -The documentation for the develop-branch can be found here: -https://vkcv.de/develop/ - -The documentation concerning the respective merge request is listed here: -https://vkcv.de/branch/ +A pre-built documentation can be found here: +https://userpages.uni-koblenz.de/~vkcv/doc/ -It is automatically generated and uploaded using the CI pipeline. +But it is recommended to build the documentation with Doxygen locally to get the most recent changes. There is also an optional CMake target to build the documentation via Doxygen. diff --git a/modules/algorithm/README.md b/modules/algorithm/README.md index b01dbbef..551fe094 100644 --- a/modules/algorithm/README.md +++ b/modules/algorithm/README.md @@ -12,4 +12,4 @@ A VkCV module to use different optimized algorithms ## Docs -Here is a [link](https://vkcv.de/develop/group__vkcv__algorithm.html) to this module. +Here is a [link](https://userpages.uni-koblenz.de/~vkcv/doc/group__vkcv__algorithm.html) to this module. diff --git a/modules/asset_loader/README.md b/modules/asset_loader/README.md index 61caa08a..aad7cdb5 100644 --- a/modules/asset_loader/README.md +++ b/modules/asset_loader/README.md @@ -14,4 +14,4 @@ A VkCV module to load basic assets like models, materials and images ## Docs -Here is a [link](https://vkcv.de/develop/group__vkcv__asset.html) to this module. +Here is a [link](https://userpages.uni-koblenz.de/~vkcv/doc/group__vkcv__asset.html) to this module. diff --git a/modules/camera/README.md b/modules/camera/README.md index cd9e3e01..d59b4bca 100644 --- a/modules/camera/README.md +++ b/modules/camera/README.md @@ -12,4 +12,4 @@ A VkCV module to manage cameras and their handle view and projection matrices ## Docs -Here is a [link](https://vkcv.de/develop/group__vkcv__camera.html) to this module. +Here is a [link](https://userpages.uni-koblenz.de/~vkcv/doc/group__vkcv__camera.html) to this module. diff --git a/modules/effects/README.md b/modules/effects/README.md index 4e035831..87639f4b 100644 --- a/modules/effects/README.md +++ b/modules/effects/README.md @@ -12,4 +12,4 @@ A VkCV module to add post-processing effects to images in realtime after renderi ## Docs -Here is a [link](https://vkcv.de/develop/group__vkcv__effects.html) to this module. +Here is a [link](https://userpages.uni-koblenz.de/~vkcv/doc/group__vkcv__effects.html) to this module. diff --git a/modules/gui/README.md b/modules/gui/README.md index 07926405..82390082 100644 --- a/modules/gui/README.md +++ b/modules/gui/README.md @@ -12,5 +12,5 @@ A VkCV module to integrate GUI rendering to your application as additional pass ## Docs -Here is a [link](https://vkcv.de/develop/group__vkcv__gui.html) to this module. +Here is a [link](https://userpages.uni-koblenz.de/~vkcv/doc/group__vkcv__gui.html) to this module. diff --git a/modules/material/README.md b/modules/material/README.md index c56a5cc1..a3cff07c 100644 --- a/modules/material/README.md +++ b/modules/material/README.md @@ -4,4 +4,4 @@ A VkCV module to abstract typical kinds of materials for rendering ## Docs -Here is a [link](https://vkcv.de/develop/group__vkcv__asset.html) to this module. +Here is a [link](https://userpages.uni-koblenz.de/~vkcv/doc/group__vkcv__asset.html) to this module. diff --git a/modules/meshlet/README.md b/modules/meshlet/README.md index 2fe1a734..4ef20972 100644 --- a/modules/meshlet/README.md +++ b/modules/meshlet/README.md @@ -4,4 +4,4 @@ A VkCV module to divide vertex data of a mesh into meshlets ## Docs -Here is a [link](https://vkcv.de/develop/group__vkcv__meshlet.html) to this module. +Here is a [link](https://userpages.uni-koblenz.de/~vkcv/doc/group__vkcv__meshlet.html) to this module. diff --git a/modules/scene/README.md b/modules/scene/README.md index 4b759615..77837163 100644 --- a/modules/scene/README.md +++ b/modules/scene/README.md @@ -4,4 +4,4 @@ A VkCV module to load and manage a scene, simplify its rendering and potentially ## Docs -Here is a [link](https://vkcv.de/develop/group__vkcv__scene.html) to this module. +Here is a [link](https://userpages.uni-koblenz.de/~vkcv/doc/group__vkcv__scene.html) to this module. diff --git a/modules/shader_compiler/README.md b/modules/shader_compiler/README.md index 03b195e6..3b64e10e 100644 --- a/modules/shader_compiler/README.md +++ b/modules/shader_compiler/README.md @@ -12,4 +12,4 @@ A VkCV module to compile shaders at runtime ## Docs -Here is a [link](https://vkcv.de/develop/group__vkcv__shader.html) to this module. +Here is a [link](https://userpages.uni-koblenz.de/~vkcv/doc/group__vkcv__shader.html) to this module. diff --git a/modules/upscaling/README.md b/modules/upscaling/README.md index fc64bf84..57f6dbdc 100644 --- a/modules/upscaling/README.md +++ b/modules/upscaling/README.md @@ -9,7 +9,8 @@ A VkCV module to upscale images in realtime | Name of dependency | Used as submodule | |----------------------------------------------------|---| | [FidelityFX-FSR](https://github.com/GPUOpen-Effects/FidelityFX-FSR/) | ✅ | +| [NVIDIAImageScaling](https://github.com/NVIDIAGameWorks/NVIDIAImageScaling/) | ✅ | ## Docs -Here is a [link](https://vkcv.de/develop/group__vkcv__upscaling.html) to this module. +Here is a [link](https://userpages.uni-koblenz.de/~vkcv/doc/group__vkcv__upscaling.html) to this module. -- GitLab