wxcafe/Kaleidoscope
1
0
Fork 0
Code Releases Activity

update README

Browse Source
This commit is contained in:
Clément Hertling 2020-07-08 17:45:51 -04:00
parent f79d7070ee
commit 2a9410f443
1 changed files with 1 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

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