Skip to content

Latest commit

 

History

History
93 lines (71 loc) · 4.31 KB

README.md

File metadata and controls

93 lines (71 loc) · 4.31 KB

VkCV Framework

A Vulkan framework for computer visualistics simplifying building applications

linux-build-on-github windows-build-on-github macos-build-on-github

Vulkan-Chan

Repository

Git LFS is used for bigger resource files like meshes and textures. So you need to install Git LFS and use git lfs install after cloning.

More information about Git LFS here.

Build

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.

Detailed build process:

Dependencies (required):

Most dependencies are 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
Vulkan-Headers
Vulkan-Hpp
GLFW
SPIRV-CROSS
VulkanMemoryAllocator-Hpp

Modules (optional):

The following modules are provided in this repository and they build automatically together with the framework if used. You can configure/adjust the build using CMake if necessary.

Projects (optional):

The following projects are provided in this repository and can be build with their own CMake targets:

Development

See this guide to setup your IDE for most forward development.

Documentation

A pre-built documentation can be found here:
https://userpages.uni-koblenz.de/~vkcv/doc/

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.