summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorOscar Michael Abrina <abrinao@amazon.com>2021-04-14 10:08:39 -0700
committerGitHub <noreply@github.com>2021-04-14 10:08:39 -0700
commit4249f5ce110a07ec70d9219f115a6350bd4a87ff (patch)
treee9615b852d2c365cc21dc27395a82a95c44b95cb
parent5440581dcd1e1fb7a8f61171917e9cbd0eff655f (diff)
downloadfreertos-git-4249f5ce110a07ec70d9219f115a6350bd4a87ff.tar.gz
Update README cloning instructions to set core.symlinks for Windows (#556)
* Update README cloning instructions to set core.symlinks for Windows * Add purpose
-rw-r--r--README.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/README.md b/README.md
index 37b67389b..baaa50ae1 100644
--- a/README.md
+++ b/README.md
@@ -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