summaryrefslogtreecommitdiffstats
path: root/keyboards/adpenrose/kintsugi/keymaps/snailmap_port/readme.md
blob: eb7b7577af0f9e5b657c18553c98aaaa2cc490ed (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
# SnailMap-ported keymap for the Kintsugi

## Features

- Keyboard matrix that highlights whichever key is currently pressed.
- Little cute snail icon that changes acording to the current WPM.
- Counters for current and max WPM values.
- Active layer name.
- Mini WPM graph.

## How to customize

The `OLED configuration variables` can be used to easily customize the display:

```
oled_horizontal     - Horizontal or vertical orientation
graph_direction     - Graph movement direction
graph_refresh       - Frequency of graph lines
graph_top_wpm       - WPM required to reach the top of the graph
icon_med_wpm        - WPM required to display the medium snail
icon_fast_wpm       - WPM required to display the fast snail
MA_LAYER_NAME       - Layer 0 display name
L1_LAYER_NAME       - Layer 1 display name
L2_LAYER_NAME       - Layer 2 display name
L3_LAYER_NAME       - Layer 3 display name
```

___

###### *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).*