summaryrefslogtreecommitdiff
path: root/keyboards/nullbitsco/nibble/keymaps/snailmap/readme.md
diff options
context:
space:
mode:
authordogspace <43654839+dogspace@users.noreply.github.com>2021-08-30 14:42:04 -0400
committerGitHub <noreply@github.com>2021-08-30 11:42:04 -0700
commit27aebba1b1eadedf2ce25efc081aef3bdbbaab7a (patch)
tree105f7e14a7063a1afb31b261f5b3b2baee61bc4e /keyboards/nullbitsco/nibble/keymaps/snailmap/readme.md
parentc9283f4c1f073da0072638e78b3d5bf5619a89f4 (diff)
[Keymap] Add new snailmap keymap to nullbitsco/nibble keyboard (#14024)
Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/nullbitsco/nibble/keymaps/snailmap/readme.md')
-rw-r--r--keyboards/nullbitsco/nibble/keymaps/snailmap/readme.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/keyboards/nullbitsco/nibble/keymaps/snailmap/readme.md b/keyboards/nullbitsco/nibble/keymaps/snailmap/readme.md
new file mode 100644
index 0000000000..5ea93b01af
--- /dev/null
+++ b/keyboards/nullbitsco/nibble/keymaps/snailmap/readme.md
@@ -0,0 +1,36 @@
+
+# SnailMap
+
+![KeySnail](https://i.imgur.com/yEQJyI2h.png)
+
+## :snail: Display
+
+- Mini keyboard that highlights the currently pressed keys
+- Snail icon that changes based on the current WPM
+- Current and max WPM counters
+- Active layer name
+- WPM graph
+
+## :gear: Customization
+
+The `OLED configuration variables` can be used to easily customize the display
+
+```
+oled_horizontal - Horizontal or vertical orientation
+ansi_layout - ANSI or ISO layout
+split_space - Bottom row spacebar
+three_mods_left - Left modifier keys
+three_mods_right - Right modifier keys
+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
+```
+___
+
+###### *Keymap created by* [dogspace](https://github.com/dogspace)