diff --git a/README.md b/README.md index fa0d833ea8ba66c6851296a4e12b5d06d7ab0406..202672d0f73c2ea19287c8809093fbe41a388d21 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 b01dbbef7d8f6aa3ff4862d76442c892c6f3ce4f..551fe0941f84c4417717b7b7dfbdebfa37c245f2 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 61caa08aa0d9863ce1ad14e7ecde6fd7cb6eed4a..aad7cdb53c7ae95d39e68a5cd814cb939b121d44 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 cd9e3e01213821108eb38f1656285fb583795034..d59b4bcaef00d7bf68776b68ba6b36e9f79dbd71 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 4e035831381f50a66cf405c06fadbb63f4273bc0..87639f4bff19fd8151d359b36c6ff34960782e3e 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 079264056e0fa16a4db752d8fe96fe0e42426258..823900829d5a3ca7b2f64dc1c05bda3e9dd55b87 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 c56a5cc19ae147106bda818775bcb828a69ba845..a3cff07cc25900f4d06ee9059dcd7175d14f3e3d 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 2fe1a7342c6a21d9694e49fc1e8b6decf43a9786..4ef209723aa95b8d2e50ff6804f19819f3e11d54 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 4b7596159ce741e584b9395bdde4c8577de3e5d8..77837163d7de34fb6ce280697e84c8b047180369 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 03b195e65dbed45c3b91a1fc766b9e12d619c971..3b64e10e5eb8de251de3ce2695e499e6e15f746b 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 fc64bf84726fd2bda45efd988b588704a965e0f0..57f6dbdc8a9457982580170755a751fee74cefa6 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.