qmk_firmware

QMK firmware for my keyboards (Corne, Sweep Ferris) and trackball (Ploopy Adept)
Log | Files | Refs | Submodules | LICENSE

readme.md (2006B)


      1 # Elora's Default Keymap
      2 The default keymap contains 5 layers which allows it to include all keys found on an ANSI layout TKL keyboard plus media keys.
      3 Hardware features of the Elora such as OLEDs, rotary encoders and underglow are also supported.
      4 
      5 The Elora keymap is in essence identical to the [Kyria keymap](https://github.com/qmk/qmk_firmware/blob/master/keyboards/splitkb/kyria/keymaps/default/readme.md), just with an additional number row. A deep dive into the keymap is provided there.
      6 
      7 The five different layers are the following:
      8 1. Base layer (QWERTY, Colemak-DH or Dvorak)
      9 2. Navigation layer
     10 3. Symbols/Numbers layer
     11 4. Function layer
     12 5. Adjust layer
     13 
     14 ## Base layer(s)
     15 ### Qwerty
     16 ![Qwerty](https://i.imgur.com/SZB1Z5gh.jpg)
     17 
     18 ### Dvorak
     19 ![Dvorak](https://i.imgur.com/RWB5Qhnh.jpg)
     20 
     21 ### Colemak-DH
     22 ![Colemak](https://i.imgur.com/4DjdGsGh.jpg)
     23 
     24 ## Navigation layer
     25 ![Navigation](https://i.imgur.com/tDM1MZeh.jpg)
     26 
     27 ## Symbols layer
     28 ![Symbol](https://i.imgur.com/9LsxnLRh.jpg)
     29 
     30 ## Function layer
     31 ![Function](https://i.imgur.com/KMCqh7Ch.jpg)
     32 
     33 ## Adjust layer
     34 ![Adjust](https://i.imgur.com/6WtMo8ih.jpg)
     35 
     36 # Hardware Features
     37 
     38 ## Rotary Encoder
     39 The left rotary encoders are programmed to send <kbd>Left</kbd> or <kbd>Right</kbd> whereas the right encoder sends <kbd>PgUp</kbd> or <kbd>PgDn</kbd> on every turn.
     40 
     41 ## OLEDs
     42 The OLEDs display the current layer at the top of the active layers stack, the Elora logo and lock status (caps lock, num lock, scroll lock).
     43 
     44 ## Underglow
     45 The underglow LEDs should default red.
     46 
     47 ## Going further…
     48 This default keymap can be used as is, unchanged, as a daily driver for your Elora but you're invited to treat your keymap like a bonsai. At the beginning, it's just like the default keymap but from time to time, you can tweak it a little. Cut a little key here, let another combo grow there. Slowly but surely it will be a unique keymap that will fit you like a glove.
     49 
     50 Check out the #keymap-ideas channel on the official splitkb Discord server for inspiration.