You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

29 lines
1.2 KiB

  1. # SnailMap-ported keymap for the Kintsugi
  2. ## Features
  3. - Keyboard matrix that highlights whichever key is currently pressed.
  4. - Little cute snail icon that changes acording to the current WPM.
  5. - Counters for current and max WPM values.
  6. - Active layer name.
  7. - Mini WPM graph.
  8. ## How to customize
  9. The `OLED configuration variables` can be used to easily customize the display:
  10. ```
  11. oled_horizontal - Horizontal or vertical orientation
  12. graph_direction - Graph movement direction
  13. graph_refresh - Frequency of graph lines
  14. graph_top_wpm - WPM required to reach the top of the graph
  15. icon_med_wpm - WPM required to display the medium snail
  16. icon_fast_wpm - WPM required to display the fast snail
  17. MA_LAYER_NAME - Layer 0 display name
  18. L1_LAYER_NAME - Layer 1 display name
  19. L2_LAYER_NAME - Layer 2 display name
  20. L3_LAYER_NAME - Layer 3 display name
  21. ```
  22. ___
  23. ###### *This keymap is an adaptation designed to work with the Kintsugi keyboard. The original SnailMap keymap was created by [dogspace](https://github.com/dogspace) for the Nibble keyboard, and you can check it [here](https://github.com/qmk/qmk_firmware/tree/master/keyboards/nullbitsco/nibble/keymaps/snailmap).*