From 2a9410f443888bd4c2e896c749431a744ebcfb3a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20Hertling?= Date: Wed, 8 Jul 2020 17:45:51 -0400 Subject: [PATCH] update README --- README.md | 35 +---------------------------------- 1 file changed, 1 insertion(+), 34 deletions(-) diff --git a/README.md b/README.md index 3158782..c078600 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,3 @@ # 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: - -``` -% make checkout-submodules -``` - -As a maintainer, you can pull all the referenced modules to the latest upstream -tips of the modules' canonical branches: - -``` -% make maintainer-update-submodules -``` - -Do note that in order to commit the changes to the submodules of a given repository, -you'll need to commit and push the changes in that repository - -To add a submodule, use a commandline like this: - -``` -% git submodule add https://github.com/Keyboardio/Kaleidoscope-Plugin/ libraries/Kaleidoscope-Plugin -``` +You want to go to https://git.wxcafe.net/wxcafe/Model01-Firmware instead to build the firmware