Skip to content

Commit c89adb6

Browse files
committed
Adding instruction for cloning repo with submodule.
1 parent caa8a96 commit c89adb6

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

Diff for: README.md

+20-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,23 @@ With FreeRTOS+POSIX, an existing POSIX threading compliant application can be po
66

77
For more on FreeRTOS+POSIX, please visit [freertos.org](https://www.freertos.org/FreeRTOS-Plus/FreeRTOS_Plus_POSIX/index.html)
88

9-
The demo project is located under ```FreeRTOS-Plus\Demo\FreeRTOS_Plus_POSIX_with_actor_Windows_Simulator```.
9+
The demo project is located under ```FreeRTOS-Plus\Demo\FreeRTOS_Plus_POSIX_with_actor_Windows_Simulator```.
10+
11+
## Cloning
12+
This repo uses [Git Submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules) to bring in dependent components.
13+
14+
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)
15+
16+
To clone using HTTPS:
17+
```
18+
git clone https://github.com/FreeRTOS/Lab-Project-FreeRTOS-POSIX.git --recurse-submodules
19+
```
20+
Using SSH:
21+
```
22+
git clone [email protected]:FreeRTOS/Lab-Project-FreeRTOS-POSIX.git --recurse-submodules
23+
```
24+
25+
If you have downloaded the repo without using the `--recurse-submodules` argument, you need to run:
26+
```
27+
git submodule update --init --recursive
28+
```

0 commit comments

Comments
 (0)