Skip to content
Snippets Groups Projects
Verified Commit cd38e49b authored by Tobias Frisch's avatar Tobias Frisch
Browse files

[#97] Adjusted framework README

parent 7d636b62
No related branches found
No related tags found
1 merge request!81Resolve "Listung von Dependencies"
Pipeline #26392 passed
This commit is part of merge request !81. Comments created here will be created in the context of that merge request.
......@@ -16,6 +16,28 @@ 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)
- [Scene](modules/scene/README.md)
- [Shader-Compiler](modules/scene/README.md)
## Documentation
The documentation for the develop-branch can be found here:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment