From 9c1de7ed22c6829442f16934e678677f8d980c21 Mon Sep 17 00:00:00 2001
From: Tobias Frisch <tfrisch@uni-koblenz.de>
Date: Thu, 15 Jul 2021 17:43:32 +0200
Subject: [PATCH] [#97] Added README per module

Signed-off-by: Tobias Frisch <tfrisch@uni-koblenz.de>
---
 modules/asset_loader/README.md    | 13 +++++++++++++
 modules/camera/README.md          | 11 +++++++++++
 modules/gui/README.md             | 11 +++++++++++
 modules/material/README.md        |  3 +++
 modules/scene/README.md           |  3 +++
 modules/shader_compiler/README.md | 11 +++++++++++
 6 files changed, 52 insertions(+)
 create mode 100644 modules/asset_loader/README.md
 create mode 100644 modules/camera/README.md
 create mode 100644 modules/gui/README.md
 create mode 100644 modules/material/README.md
 create mode 100644 modules/scene/README.md
 create mode 100644 modules/shader_compiler/README.md

diff --git a/modules/asset_loader/README.md b/modules/asset_loader/README.md
new file mode 100644
index 00000000..dd50c653
--- /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 00000000..c17ca5ed
--- /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 00000000..7e8a3309
--- /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 00000000..f00f8fc7
--- /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 00000000..fd0ca7cd
--- /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 00000000..86673e55
--- /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/)   | ✅ |
-- 
GitLab