From 571855dd2902bcd7154695369176258820ec21d9 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Mon, 18 May 2020 11:28:29 -0700 Subject: [PATCH] Update README to add a note about enabling symlinks on windows --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 02fe8a7..3158782 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,18 @@ -# Arduino Core for the Keyboardio Model 01 +# Arduino Core for Kaleidoscope keyboards + + +When checking this repository out on windows, you need to enable symlinks. To do that, you would use the git configuration option 'core.symlinks=true' + +You might use the following commandline + +``` +% git clone -c core.symlinks=true --recursive https://github.com/keyboardio/Kaleidoscope-Bundle-Keyboardio.git keyboardio +``` This repository contains a number of git submodules. + + As an end-user, you can recursively check out all the referenced modules: ```