Add a note about symlinks on Windows, thanks to Johannes Becker.

Fixes #766
pull/849/head
Jesse Vincent 5 years ago
parent d6868bf2ae
commit 97d4f4e991

@ -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
```

Loading…
Cancel
Save