Merge branch '97-listung-von-dependencies' into 'develop'

Resolve "Listung von Dependencies"

Closes #97

See merge request !81

README.md

@@ -16,6 +16,30 @@ More information about Git LFS [here](https://git-lfs.github.com/).
 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`.
 
+### Dependencies (required):
+
+Most dependencies will be used via submodules but for example Vulkan needs to be installed correctly depending on your platform. So please setup your environment properly.
+
+| Name of dependency | Used as submodule |
+|-----------------------------------|---|
+| [Vulkan](https://www.vulkan.org/) | ❌ |
+| [GLFW](https://www.glfw.org/) | ✅ |
+| [SPIRV-CROSS](https://github.com/KhronosGroup/SPIRV-Cross) | ✅ |
+| [VulkanMemoryAllocator-Hpp](https://github.com/malte-v/VulkanMemoryAllocator-Hpp) | ✅ |
+
+### Modules (optional):
+
+The following modules will be provided in this repository and they will automatically be builded together with the framework if used. You can configure/adjust the build using CMake if necessary.
+
+ - [Asset-Loader](modules/asset_loader/README.md)
+ - [Camera](modules/asset_loader/README.md)
+ - [GUI](modules/gui/README.md)
+ - [Material](modules/material/README.md)
+ - [Meshlet](modules/meshlet/README.md)
+ - [Scene](modules/scene/README.md)
+ - [Shader-Compiler](modules/shader_compiler/README.md)
+ - [Upscaling](modules/upscaling/README.md)
+
 ## Documentation
 
 The documentation for the develop-branch can be found here:  

modules/asset_loader/README.md

+# Asset-Loader
+
+A VkCV module to load basic assets like models, materials and images
+
+## Build
+
+### Dependencies (required):
+
+| Name of dependency | Used as submodule |
+|----------------------------------------------------|---|
+| [fx-gltf](https://github.com/jessey-git/fx-gltf)   | ✅ |
+| [nlohmann::json](https://github.com/nlohmann/json) | ✅ |
+| [stb](https://github.com/nothings/stb)             | ✅ |
+
+## Docs
+
+Here is a [link](https://vkcv.de/develop/group__vkcv__asset.html) to this module.

modules/camera/README.md

+# Camera
+
+A VkCV module to manage cameras and their handle view and projection matrices
+
+## Build
+
+### Dependencies (required):
+
+| Name of dependency | Used as submodule |
+|----------------------------------------------------|---|
+| [GLM](https://github.com/g-truc/glm)   | ✅ |
+
+## Docs
+
+Here is a [link](https://vkcv.de/develop/group__vkcv__camera.html) to this module.

modules/gui/README.md

+# GUI
+
+A VkCV module to integrate GUI rendering to your application as additional pass
+
+## Build
+
+### Dependencies (required):
+
+| Name of dependency | Used as submodule |
+|----------------------------------------------------|---|
+| [ImGUI](https://github.com/ocornut/imgui/)   | ✅ |
+
+## Docs
+
+Here is a [link](https://vkcv.de/develop/group__vkcv__gui.html) to this module.
+

modules/material/README.md

+# Material
+
+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.

modules/meshlet/README.md

+# Meshlet
+
+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.

modules/scene/README.md

+# Scene
+
+A VkCV module to load and manage a scene, simplify its rendering and potentially optimize it
+
+## Docs
+
+Here is a [link](https://vkcv.de/develop/group__vkcv__scene.html) to this module.

modules/shader_compiler/README.md

+# Shader-Compiler
+
+A VkCV module to compile shaders at runtime
+
+## Build
+
+### Dependencies (required):
+
+| Name of dependency | Used as submodule |
+|----------------------------------------------------|---|
+| [Glslang](https://github.com/KhronosGroup/glslang/)   | ✅ |
+
+## Docs
+
+Here is a [link](https://vkcv.de/develop/group__vkcv__shader.html) to this module.

modules/upscaling/README.md

+# Upscaling
+
+A VkCV module to upscale images in realtime
+
+## Build
+
+### Dependencies (required):
+
+| Name of dependency | Used as submodule |
+|----------------------------------------------------|---|
+| [FidelityFX-FSR](https://github.com/GPUOpen-Effects/FidelityFX-FSR/)   | ✅ |
+
+## Docs
+
+Here is a [link](https://vkcv.de/develop/group__vkcv__upscaling.html) to this module.