From 97d4f4e991810a49e58ef4db88fede9193a7eed5 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Mon, 18 May 2020 11:31:33 -0700 Subject: [PATCH] Add a note about symlinks on Windows, thanks to Johannes Becker. Fixes #766 --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cc56e848..3bc5dea5 100644 --- a/README.md +++ b/README.md @@ -41,8 +41,11 @@ cd %userprofile%\Documents\Arduino\hardware ### Install the libraries and hardware definitions ## Clone the hardware definitions + +Because git for Windows doesn't always have symlink support enabled by default, you may need to enable it for Kaleidoscope. To do that, add '-c core.symlinks=true' to your commandline. On all other platforms, that option is safe, but not necessary, as symlinks should work by default. + ```sh -git clone --recursive https://github.com/keyboardio/Kaleidoscope-Bundle-Keyboardio.git keyboardio +git clone -c core.symlinks=true --recursive https://github.com/keyboardio/Kaleidoscope-Bundle-Keyboardio.git keyboardio ```