diff options
| author | jasonpcarroll <23126711+jasonpcarroll@users.noreply.github.com> | 2021-07-23 00:35:53 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-07-23 00:35:53 -0700 |
| commit | 64eaecc31bc5564b353b82f0c0359acc903ba8ac (patch) | |
| tree | 91d024367dd2cfcb5798abd9212b4d6794461070 | |
| parent | 17efff0e34ef773e2010253cf7b68ae8f13901a9 (diff) | |
| download | freertos-git-64eaecc31bc5564b353b82f0c0359acc903ba8ac.tar.gz | |
Updated README.md to reflect Windows symlink issues. (#660)
Co-authored-by: Jason Carroll <czjaso@amazon.com>
| -rw-r--r-- | README.md | 3 |
1 files changed, 2 insertions, 1 deletions
@@ -11,10 +11,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: +If using Windows, because this repository and its submodules contain symbolic links, set `core.symlinks` to true with the following command: ``` git config --global core.symlinks true ``` +In addition to this, either enable [Developer Mode](https://docs.microsoft.com/en-us/windows/apps/get-started/enable-your-device-for-development) or, whenever using a git command that writes to the system (e.g. `git pull`, `git clone`, and `git submodule update --init --recursive`), use a console elevated as administrator so that git can properly create symbolic links for this repository. Otherwise, symbolic links will be written as normal files with the symbolic links' paths in them as text. [This](https://blogs.windows.com/windowsdeveloper/2016/12/02/symlinks-windows-10/) gives more explanation. To clone using HTTPS: ``` |