summaryrefslogtreecommitdiff
path: root/keyboards/massdrop/alt/keymaps/via/readme.md
diff options
context:
space:
mode:
authorQMK Bot <hello@qmk.fm>2022-08-14 19:26:44 +0000
committerQMK Bot <hello@qmk.fm>2022-08-14 19:26:44 +0000
commite6a522417a8292ca6634b08d4db96c0cb4323534 (patch)
tree4e0125f24f5b52cd115f8fe6f7ad637341b5f39e /keyboards/massdrop/alt/keymaps/via/readme.md
parent95c43a275984fb57cdf6e5afd02190700e0205bc (diff)
parent5f74ae5b636d650ecdf5d663f6d8a414fe25caf7 (diff)
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'keyboards/massdrop/alt/keymaps/via/readme.md')
-rw-r--r--keyboards/massdrop/alt/keymaps/via/readme.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/keyboards/massdrop/alt/keymaps/via/readme.md b/keyboards/massdrop/alt/keymaps/via/readme.md
new file mode 100644
index 0000000000..1315fb085d
--- /dev/null
+++ b/keyboards/massdrop/alt/keymaps/via/readme.md
@@ -0,0 +1,24 @@
+# VIA keymap for the Drop Alt Keyboard
+## *LED Modes:*
+Enables all RGB Matrix animation modes available in QMK, all of which are selectable through VIA or using the LED mode keys
+
+```c
+#define USB_LED_INDICATOR_ENABLE
+#define RGB_MATRIX_FRAMEBUFFER_EFFECTS
+#define RGB_MATRIX_KEYPRESSES
+```
+
+## *User Keycodes:*
+All keyboard specific keycodes are defined in the user_keycodes space, allowing for them to be placed on your keyboard through VIA
+
+```c
+enum alt_keycodes {
+ U_T_AUTO = USER00, //USB Extra Port Toggle Auto Detect / Always Active
+ U_T_AGCR, //USB Toggle Automatic GCR control
+ DBG_TOG, //DEBUG Toggle On / Off
+ DBG_MTRX, //DEBUG Toggle Matrix Prints
+ DBG_KBD, //DEBUG Toggle Keyboard Prints
+ DBG_MOU, //DEBUG Toggle Mouse Prints
+ MD_BOOT, //Restart into bootloader after hold timeout
+};
+``` \ No newline at end of file