summaryrefslogtreecommitdiffstats
path: root/keyboards/bastardkb/charybdis/3x6/keymaps/default/readme.md
diff options
context:
space:
mode:
authorlokher <lokher@gmail.com>2022-09-13 11:13:00 +0800
committerlokher <lokher@gmail.com>2022-09-13 11:13:00 +0800
commitfe13cedf8c09fa34d5cec4e4c624738095176625 (patch)
tree818436626d49c7f22f325632b2053edba10d4358 /keyboards/bastardkb/charybdis/3x6/keymaps/default/readme.md
parentfa207545a9759c50b9f230eb608d86a9085801d4 (diff)
parentf46379f308783994b8178f95adc686f4b4c3ebd8 (diff)
merge upstream master
Diffstat (limited to 'keyboards/bastardkb/charybdis/3x6/keymaps/default/readme.md')
-rw-r--r--keyboards/bastardkb/charybdis/3x6/keymaps/default/readme.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/keyboards/bastardkb/charybdis/3x6/keymaps/default/readme.md b/keyboards/bastardkb/charybdis/3x6/keymaps/default/readme.md
new file mode 100644
index 0000000000..8b407f68a2
--- /dev/null
+++ b/keyboards/bastardkb/charybdis/3x6/keymaps/default/readme.md
@@ -0,0 +1,7 @@
+# Charybdis Mini (3x6) default keymap
+
+> :bulb: Have a look at the [`via` keymap](../via) for a more feature-rich layout.
+
+The Charydbis Mini (3x6) default keymap is inspired from the original [Dactyl Manuform](../../../../../handwired/dactyl_manuform) default keymap.
+
+This layout supports RGB matrix. However, due to space constraints on the MCU, only a limited number of effect can be enabled at once. Look at the `config.h` file and enable your favorite effect.