diff --git a/README.md b/README.md index 14648f0b..fb3c60ca 100644 --- a/README.md +++ b/README.md @@ -74,9 +74,22 @@ This can also be used to control which fork is used. ## Adding splitkb fork to an existing fork +### New branch + If you have already forked the qmk/qmk_userspace repository before you may need to manually add the `halcyon` branch. 1. Add a new upstream `git remote add upstream https://github.com/splitkb/qmk_userspace.git` 1. Fetch the upstream `git fetch upstream` 1. Create a new branch based on the upstream `git checkout -b halcyon upstream/halcyon` 1. Make any changes you want and push it to github `git push -u origin halcyon` + +### Existing branch + +You may also want to just add the files to your own branch if you have already setup a custom userspace before. + +1. Clone or download the files from our fork or add it as a new branch as above. +1. Copy over the contents of `users/halcyon_modules/rules.mk` and the `users/halcyon_modules/splitkb/` folder to your personal user folder. + +If you want to modify an existing keymap (from the original Kyria, Elora or an Aurora board for example). Make sure to add 10 new keys in your keymap (Look at `keyboards/splitkb/halcyon/kyria/keymaps/default_hlc` for an example). + +Do note that we use some quantum functions in our userspace so there may be a conflict when compiling. If you use the `_user` functions you should be fine. diff --git a/halcyon_info.json b/halcyon_info.json new file mode 100644 index 00000000..788919b8 --- /dev/null +++ b/halcyon_info.json @@ -0,0 +1,68 @@ +{ + "layouts": { + "LAYOUT_split_3x6_5_hlc": { + "layout": [ + {"label": "L06", "matrix": [0, 6], "x": 0, "y": 0.75}, + {"label": "L05", "matrix": [0, 5], "x": 1, "y": 0.75}, + {"label": "L04", "matrix": [0, 4], "x": 2, "y": 0.25}, + {"label": "L03", "matrix": [0, 3], "x": 3, "y": 0}, + {"label": "L02", "matrix": [0, 2], "x": 4, "y": 0.25}, + {"label": "L01", "matrix": [0, 1], "x": 5, "y": 0.5}, + {"label": "R01", "matrix": [5, 1], "x": 10.5, "y": 0.5}, + {"label": "R02", "matrix": [5, 2], "x": 11.5, "y": 0.25}, + {"label": "R03", "matrix": [5, 3], "x": 12.5, "y": 0}, + {"label": "R04", "matrix": [5, 4], "x": 13.5, "y": 0.25}, + {"label": "R05", "matrix": [5, 5], "x": 14.5, "y": 0.75}, + {"label": "R06", "matrix": [5, 6], "x": 15.5, "y": 0.75}, + {"label": "L12", "matrix": [1, 6], "x": 0, "y": 1.75}, + {"label": "L11", "matrix": [1, 5], "x": 1, "y": 1.75}, + {"label": "L10", "matrix": [1, 4], "x": 2, "y": 1.25}, + {"label": "L09", "matrix": [1, 3], "x": 3, "y": 1}, + {"label": "L08", "matrix": [1, 2], "x": 4, "y": 1.25}, + {"label": "L07", "matrix": [1, 1], "x": 5, "y": 1.5}, + {"label": "R07", "matrix": [6, 1], "x": 10.5, "y": 1.5}, + {"label": "R08", "matrix": [6, 2], "x": 11.5, "y": 1.25}, + {"label": "R09", "matrix": [6, 3], "x": 12.5, "y": 1}, + {"label": "R10", "matrix": [6, 4], "x": 13.5, "y": 1.25}, + {"label": "R11", "matrix": [6, 5], "x": 14.5, "y": 1.75}, + {"label": "R12", "matrix": [6, 6], "x": 15.5, "y": 1.75}, + {"label": "L20", "matrix": [2, 6], "x": 0, "y": 2.75}, + {"label": "L19", "matrix": [2, 5], "x": 1, "y": 2.75}, + {"label": "L18", "matrix": [2, 4], "x": 2, "y": 2.25}, + {"label": "L17", "matrix": [2, 3], "x": 3, "y": 2}, + {"label": "L16", "matrix": [2, 2], "x": 4, "y": 2.25}, + {"label": "L15", "matrix": [2, 1], "x": 5, "y": 2.5}, + {"label": "L14", "matrix": [3, 3], "x": 6, "y": 3}, + {"label": "L13", "matrix": [2, 0], "x": 7, "y": 3.25}, + {"label": "R13", "matrix": [7, 0], "x": 8.5, "y": 3.25}, + {"label": "R14", "matrix": [8, 3], "x": 9.5, "y": 3}, + {"label": "R15", "matrix": [7, 1], "x": 10.5, "y": 2.5}, + {"label": "R16", "matrix": [7, 2], "x": 11.5, "y": 2.25}, + {"label": "R17", "matrix": [7, 3], "x": 12.5, "y": 2}, + {"label": "R18", "matrix": [7, 4], "x": 13.5, "y": 2.25}, + {"label": "R19", "matrix": [7, 5], "x": 14.5, "y": 2.75}, + {"label": "R20", "matrix": [7, 6], "x": 15.5, "y": 2.75}, + {"label": "L25", "matrix": [3, 4], "x": 2.5, "y": 3.25}, + {"label": "L24", "matrix": [3, 2], "x": 3.5, "y": 3.25}, + {"label": "L23", "matrix": [3, 1], "x": 4.5, "y": 3.5}, + {"label": "L22", "matrix": [3, 5], "x": 5.5, "y": 4}, + {"label": "L21", "matrix": [3, 0], "x": 6.5, "y": 4.25}, + {"label": "R21", "matrix": [8, 0], "x": 9, "y": 4.25}, + {"label": "R22", "matrix": [8, 5], "x": 10, "y": 4}, + {"label": "R23", "matrix": [8, 1], "x": 11, "y": 3.5}, + {"label": "R24", "matrix": [8, 2], "x": 12, "y": 3.25}, + {"label": "R25", "matrix": [8, 4], "x": 13, "y": 3.25}, + {"matrix": [4, 0], "x": 0, "y": 6}, + {"matrix": [4, 1], "x": 1, "y": 6}, + {"matrix": [4, 2], "x": 2, "y": 6}, + {"matrix": [4, 3], "x": 3, "y": 6}, + {"matrix": [4, 4], "x": 4, "y": 6}, + {"matrix": [9, 0], "x": 15.5, "y": 6}, + {"matrix": [9, 1], "x": 14.5, "y": 6}, + {"matrix": [9, 2], "x": 13.5, "y": 6}, + {"matrix": [9, 3], "x": 12.5, "y": 6}, + {"matrix": [9, 4], "x": 11.5, "y": 6} + ] + } + } +}