diff options
Diffstat (limited to 'keyboards/sofle/keymaps/keyhive_via/readme.md')
| -rw-r--r-- | keyboards/sofle/keymaps/keyhive_via/readme.md | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/keyboards/sofle/keymaps/keyhive_via/readme.md b/keyboards/sofle/keymaps/keyhive_via/readme.md new file mode 100644 index 0000000000..e7a2beebcf --- /dev/null +++ b/keyboards/sofle/keymaps/keyhive_via/readme.md @@ -0,0 +1,49 @@ +# Only compatible with sofle/keyhive firmware which adds an extra column of keys for encoder mapping. + + + +# Configuring VIA / Vial App + +This firmware will not auto-recognize until [PR #1060](https://github.com/the-via/keyboards/pull/1060) is accepted to the VIA keyboard database. For now you must install the new layout: + +1. Download [keyhive_sofle_rgb.json](https://raw.githubusercontent.com/the-via/keyboards/48372baae5ab451d752988121fa4f1dd47b2c1ce/src/sofle/keyhive_sofle_rgb.json). +2. In the VIA app, select `File > Import Keymap` from the menu. +3. Open the file you just downloaded. + +**You'll have to do this every time you use VIA or Vial until the PR is accepted.** + +# Using with VIA +* The default layouts should be loaded automatically. +* Layouts can be backed up in VIA in the SAVE+LOAD section. +* It is a good idea to Save Current Layout after you decide on your mapping. + +# Custom Features: + +### Rotary Encoder and VIA Features: +* Fully remappable. Left encoder controls volume up/down/mute. Right encoder PGUP/PGDOWN. +* Allows for live remapping of per-layer rotary encoder functions in VIA. +* VIA support with **keyhive_via** keymap. + +# Compiling + +Make example for this keyboard (after setting up your build environment): + + make sofle/keyhive:keyhive_via + +## Flashing + +Flash using the correct command below (or use QMK Toolbox). These commands can be mixed if, for example, you have an Elite C on the left and a pro micro on the right. + +Press reset button on the keyboard when asked. + +Disconnect the first half, connect the second one and repeat the process. + + # for Pro Micro-based builds + make sofle/keyhive:keyhive_via:avrdude-split-left + make sofle/keyhive:keyhive_via:avrdude-split-right + + # for Elite C or DFU bootloader builds + make sofle/keyhive:keyhive_via:dfu-split-left + make sofle/keyhive:keyhive_via:dfu-split-right + +See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). |