From 4249f5ce110a07ec70d9219f115a6350bd4a87ff Mon Sep 17 00:00:00 2001 From: Oscar Michael Abrina Date: Wed, 14 Apr 2021 10:08:39 -0700 Subject: [PATCH] Update README cloning instructions to set core.symlinks for Windows (#556) * Update README cloning instructions to set core.symlinks for Windows * Add purpose --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 37b67389b8..baaa50ae1b 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