Update README cloning instructions to set core.symlinks for Windows (#556)

* Update README cloning instructions to set core.symlinks for Windows

* Add purpose
This commit is contained in:
Oscar Michael Abrina 2021-04-14 10:08:39 -07:00 committed by GitHub
parent 5440581dcd
commit 4249f5ce11
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -12,6 +12,11 @@ This repo uses [Git Submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodu
**Note:** If you download the ZIP file provided by the GitHub UI, you will not get the contents of the submodules. (The ZIP file is also not a valid git repository)
If using Windows, set `core.symlinks` to true since copying a directory with symlinks may cause hangups:
```
git config --global core.symlinks true
```
To clone using HTTPS:
```
git clone https://github.com/FreeRTOS/FreeRTOS.git --recurse-submodules