summaryrefslogtreecommitdiffstats
path: root/keyboards/moonlander/readme.md
diff options
context:
space:
mode:
authorDrashna Jaelre <drashna@live.com>2021-07-25 18:18:22 -0700
committerGitHub <noreply@github.com>2021-07-25 18:18:22 -0700
commitd45da3f0fb76222a2af63b0b61f21ae78117b2d4 (patch)
tree179d3cefe72927d0759008a255437bf17419dc24 /keyboards/moonlander/readme.md
parentfc9fb2c77505cf1dcf5d1f50dd61a980471b3494 (diff)
[Keyboard] Update ZSA Keyboard Readmes and keymaps (#13041)
* [Keyboard] Update ZSA Keyboard Readmes and keymaps * Apply suggestions from code review Co-authored-by: Ryan <fauxpark@gmail.com> * Remove custom rgb code for RGB_M_P * Fix inevitable typo Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/planck/ez/readme.md Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/moonlander/readme.md')
-rw-r--r--keyboards/moonlander/readme.md18
1 files changed, 17 insertions, 1 deletions
diff --git a/keyboards/moonlander/readme.md b/keyboards/moonlander/readme.md
index 7ddfdb84a7..0ad2e4775c 100644
--- a/keyboards/moonlander/readme.md
+++ b/keyboards/moonlander/readme.md
@@ -19,7 +19,23 @@ Flashing example for this keyboard:
See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
-## Oryx Configuation
+
+## Moonlander Customization
+
+### Indicator LEDs
+
+There are 6 functions for enabling and disabling the LEDs on the top of the boards. The functions are `ML_LED_1(bool)` through `ML_LED_6(bool)`, with the first LED being the left most LED on the left hand, and the sixth LED being the right most LED on the right side.
+
+By default, the Indicator LEDs are used to indicate the layer state for the keyboard. If you wish to change this (and indicate caps/num/scroll lock status instead), then define `MOONLANDER_USER_LEDS` in your `config.h` file.
+
+
+### Oryx Configuration
+
+To enable the features from Oryx (ZSA's Configurator), either compile the the `default` keymap, or add `#define ORYX_CONFIGURATOR` to your `config.h` file.
+
+This enables the front Indicator LEDs, and the `TOGGLE_LAYER_COLOR` keycode. The `TOGGLE_LAYER_COLOR` keycode toggles the customized LED map configured on Oryx.
+
+### RGB Matrix Features
If you're using the Smart LED (layer indication) feature from the Oryx Configurator, you want to make sure that you enable these options by adding `#define ORYX_CONFIGURATOR` to your keymap's `config.h`.