summaryrefslogtreecommitdiffstats
path: root/keyboards/gmmk/pro/rev1/ansi/keymaps/mike1808/README.md
diff options
context:
space:
mode:
authorGloriousThrall <74627436+GloriousThrall@users.noreply.github.com>2022-05-19 19:47:22 -0500
committerGitHub <noreply@github.com>2022-05-20 01:47:22 +0100
commit83fa6fe916bfd7d337f05d7805f0a51ad86c8b43 (patch)
treefc279aa7123dfcf99ba8753ca01082b1f6eadbec /keyboards/gmmk/pro/rev1/ansi/keymaps/mike1808/README.md
parentb5608cbb6d8a5a24d9c3b928521acbc57726831f (diff)
Move GMMK Pro to allow for multiple revisions (#16423)
* Added GMMK PRO Rev2 WBG7 MCU compatibility. Added GMMK 2 WBG7 MCU compatibility. * GMMK PRO MCU Updates only (removed other kbs) * fix problems * Optimize the code. * Update form develop branch * Update * Updater from qmk/develop * Update * Update config.h * Update config.h * Remove gmmk pro rev2 * move moults31/keymap.c * Update * tidy up Co-authored-by: Joy <chang.li@westberrytech.com> Co-authored-by: zvecr <git@zvecr.com>
Diffstat (limited to 'keyboards/gmmk/pro/rev1/ansi/keymaps/mike1808/README.md')
-rw-r--r--keyboards/gmmk/pro/rev1/ansi/keymaps/mike1808/README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/keyboards/gmmk/pro/rev1/ansi/keymaps/mike1808/README.md b/keyboards/gmmk/pro/rev1/ansi/keymaps/mike1808/README.md
new file mode 100644
index 0000000000..cb17239882
--- /dev/null
+++ b/keyboards/gmmk/pro/rev1/ansi/keymaps/mike1808/README.md
@@ -0,0 +1,19 @@
+QMK layout for gmmk/pro
+=======================
+
+## Secrets
+The format is the same as [drashna's](../../../../users/drashna/readme_secrets.md) secrets implementation. Create a `secret.h` and define your secrets like this:
+
+```c
+static const char* secrets[] = {"secret1", "secret2", "secret3", "secret4", "secret5"};
+```
+
+## Rotary encoder knob
+You can hookup your encoder functions by defining new encoder states in [encoder.h](./encoder.h), then in [encoder.c](./encoder.c) assign static variable `state` your new state depending on your desired condition and add callbacks to `encoder_mapping` array.
+
+## RGB Matrix Ledmaps
+RGB Matrix ledmaps is the future allowing you assign colors to individual keys on every keymap layer.
+
+You can see some examples of my usage in the bottom of [keymap.c](./keymap.c).
+
+Color defines are just HSV colors wrapped in curly braces, like `#define RED { HSV_RED }`.