From c89adb6d50c37fe8c1f664c36491b5f3856b5a1a Mon Sep 17 00:00:00 2001
From: "Yuhui.Zheng" <10982575+yuhui-zheng@users.noreply.github.com>
Date: Fri, 14 Feb 2020 10:56:15 -0800
Subject: [PATCH] Adding instruction for cloning repo with submodule.

---
 README.md | 21 ++++++++++++++++++++-
 1 file changed, 20 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index de5059e..79f503b 100644
--- a/README.md
+++ b/README.md
@@ -6,4 +6,23 @@ With FreeRTOS+POSIX, an existing POSIX threading compliant application can be po
 
 For more on FreeRTOS+POSIX, please visit [freertos.org](https://www.freertos.org/FreeRTOS-Plus/FreeRTOS_Plus_POSIX/index.html)
 
-The demo project is located under ```FreeRTOS-Plus\Demo\FreeRTOS_Plus_POSIX_with_actor_Windows_Simulator```. 
\ No newline at end of file
+The demo project is located under ```FreeRTOS-Plus\Demo\FreeRTOS_Plus_POSIX_with_actor_Windows_Simulator```. 
+
+## Cloning
+This repo uses [Git Submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules) to bring in dependent components.
+
+Note: If you download the ZIP file provided by GitHub UI, you will not get the contents of the submodules. (The ZIP file is also not a valid git repository)
+
+To clone using HTTPS:
+```
+git clone https://github.com/FreeRTOS/Lab-Project-FreeRTOS-POSIX.git --recurse-submodules
+```
+Using SSH:
+```
+git clone git@github.com:FreeRTOS/Lab-Project-FreeRTOS-POSIX.git --recurse-submodules
+```
+
+If you have downloaded the repo without using the `--recurse-submodules` argument, you need to run:
+```
+git submodule update --init --recursive
+```
\ No newline at end of file