summaryrefslogtreecommitdiff
path: root/keyboards/adpenrose/akemipad/keymaps/oled_bongocat/readme.md
diff options
context:
space:
mode:
authorArturo Avila <69410272+ADPenrose@users.noreply.github.com>2022-12-27 14:09:01 -0600
committerGitHub <noreply@github.com>2022-12-27 12:09:01 -0800
commit3de3f885de12b297ba3526d7d3c3694785fd3ab8 (patch)
treea75cd3be7443e144292798597d1a271576a06ff5 /keyboards/adpenrose/akemipad/keymaps/oled_bongocat/readme.md
parent95e97fa8397eaccec1972e4233f89349cd4f06ca (diff)
[Keyboard] Add AkemiPad (#18790)
Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/adpenrose/akemipad/keymaps/oled_bongocat/readme.md')
-rw-r--r--keyboards/adpenrose/akemipad/keymaps/oled_bongocat/readme.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/keyboards/adpenrose/akemipad/keymaps/oled_bongocat/readme.md b/keyboards/adpenrose/akemipad/keymaps/oled_bongocat/readme.md
new file mode 100644
index 0000000000..5ae1b2280e
--- /dev/null
+++ b/keyboards/adpenrose/akemipad/keymaps/oled_bongocat/readme.md
@@ -0,0 +1,19 @@
+# The Bongo Cat VIA-compatible keymap for the AkemiPad
+
+# Features
+- Audio Click capabilitiy.
+- RGB Matrix Lighting (cycles left-right and up-down).
+- LEDs turn on and off depending on the layout selected on the VIA UI.
+- Encoder Map feature.
+- Bongo Cat animation with WPM counter and Caps Lock/Num Lock indicators.
+
+This keymap is optimized for a numpad and can fit the RGB matrix (with
+very few animations due to AVR constraints), the encoder map, the audio
+click feature and the display of the OLED animations. This was possible
+thanks to the [squeez-o](https://github.com/nullbitsco/squeez-o) compression tool.
+
+![Bongo Cat](https://i.imgur.com/Ty0qKnV.gif)
+
+___
+
+###### *This keymap is an adaptation designed to work with the AkemiPad. The reference keymap used was created for the Nibble keyboard, and you can check it [here](https://github.com/qmk/qmk_firmware/tree/master/keyboards/nullbitsco/nibble/keymaps/oled_bongocat).*