From cd38e49b95f61a726c657c36699c16486f624eb5 Mon Sep 17 00:00:00 2001
From: Tobias Frisch <tfrisch@uni-koblenz.de>
Date: Thu, 15 Jul 2021 17:26:31 +0200
Subject: [PATCH] [#97] Adjusted framework README

Signed-off-by: Tobias Frisch <tfrisch@uni-koblenz.de>
---
 README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/README.md b/README.md
index 29c45f26..14ad6ec0 100644
--- a/README.md
+++ b/README.md
@@ -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:  
-- 
GitLab