diff --git a/modules/asset_loader/README.md b/modules/asset_loader/README.md new file mode 100644 index 0000000000000000000000000000000000000000..dd50c65339989f4f45fc705aae8aac7e54cd7183 --- /dev/null +++ b/modules/asset_loader/README.md @@ -0,0 +1,13 @@ +# 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) | ✅ | diff --git a/modules/camera/README.md b/modules/camera/README.md new file mode 100644 index 0000000000000000000000000000000000000000..c17ca5ed6e28cb1a7964b9be9d7a82fd83f91c1c --- /dev/null +++ b/modules/camera/README.md @@ -0,0 +1,11 @@ +# 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) | ✅ | diff --git a/modules/gui/README.md b/modules/gui/README.md new file mode 100644 index 0000000000000000000000000000000000000000..7e8a3309f4ec41805fe3aebc68c31e3d188f9576 --- /dev/null +++ b/modules/gui/README.md @@ -0,0 +1,11 @@ +# 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/) | ✅ | diff --git a/modules/material/README.md b/modules/material/README.md new file mode 100644 index 0000000000000000000000000000000000000000..f00f8fc770f837fad283c1a6349187cac1ffb850 --- /dev/null +++ b/modules/material/README.md @@ -0,0 +1,3 @@ +# GUI + +A VkCV module to abstract typical kinds of materials for rendering diff --git a/modules/scene/README.md b/modules/scene/README.md new file mode 100644 index 0000000000000000000000000000000000000000..fd0ca7cd793de2e2f46a986b8e773a0fe2137adb --- /dev/null +++ b/modules/scene/README.md @@ -0,0 +1,3 @@ +# GUI + +A VkCV module to load and manage a scene, simplify its rendering and potentially optimize it diff --git a/modules/shader_compiler/README.md b/modules/shader_compiler/README.md new file mode 100644 index 0000000000000000000000000000000000000000..86673e5535ad99efe466473e51f5c36cede38383 --- /dev/null +++ b/modules/shader_compiler/README.md @@ -0,0 +1,11 @@ +# 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/) | ✅ |