From ce26f6e66471d620ffb90b8c4ebe446410033e4f Mon Sep 17 00:00:00 2001 From: DiligentGraphics Date: Tue, 12 Dec 2017 18:55:47 -0800 Subject: Update README.md --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8d8b5d2..c6fcb7c 100644 --- a/README.md +++ b/README.md @@ -10,9 +10,17 @@ as a graphics subsystem in a standalone game engine, Unity native plugin or any [shader source code converter](http://diligentgraphics.com/diligent-engine/shader-converter/) that allows shaders authored in HLSL to be translated to GLSL. -# Repository Structure +# Clonning the Repository -The repository includes the following submodules: +This is the master repository that contains three [submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules). To get the repository and all submodules, use the following command: + + git clone --recursive https://github.com/DiligentGraphics/DiligentEngine.git + + Alternatively, you can get master repository fisrt, and then individually clone all submodules into the engine's root folder. + +## Repository Structure + +Master repository includes the following submodules: * [Core](https://github.com/DiligentGraphics/DiligentCore) submodule provides basic engine functionality. It implements the engine API using [Direct3D11](https://github.com/DiligentGraphics/DiligentCore/tree/master/Graphics/GraphicsEngineD3D11), [Direct3D12](https://github.com/DiligentGraphics/DiligentCore/tree/master/Graphics/GraphicsEngineD3D12), and -- cgit v1.2.3