# VkCV Framework
 A Vulkan framework for computer visualistics simplifying building applications

![Vulkan-Chan](https://gitlab.uni-koblenz.de/uploads/-/system/project/avatar/3712/VulkanChan.jpg)

## 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](https://git-lfs.github.com/).

## Build

 [![pipeline status](https://gitlab.uni-koblenz.de/vulkan2021/vkcv-framework/badges/develop/pipeline.svg)](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`.

## 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/  

It is automatically generated and uploaded using the CI pipeline.