diff options
Diffstat (limited to 'keyboards/mxss/readme.md')
| -rw-r--r-- | keyboards/mxss/readme.md | 34 |
1 files changed, 10 insertions, 24 deletions
diff --git a/keyboards/mxss/readme.md b/keyboards/mxss/readme.md index 17343be526..e22fe256ed 100644 --- a/keyboards/mxss/readme.md +++ b/keyboards/mxss/readme.md @@ -2,11 +2,6 @@  -### Important Note: -**This PCB supports the VIA configurator, and this is the recommended way to configure the keymap on this keyboard. Building the firmware should only be necessary if you would like to change the colours of the front LEDs in indicator mode.** - -**For more information about the VIA configurator, [see here](https://caniusevia.com/).** - ### Information: - Case: Frosted Polycarbonate, CNC milled @@ -24,32 +19,23 @@ - RGB underglow - 1.5kg with plate and weight -Keyboard Maintainer: [MxBlue](https://github.com/mxblu) - -Hardware Supported: Custom PCB, ATMega32u4 - -Hardware Availability: https://geekhack.org/index.php?topic=94986.0 +* Keyboard Maintainer: [MxBlue](https://github.com/mxblu) +* Hardware Supported: Custom PCB, ATMega32u4 +* Hardware Availability: https://geekhack.org/index.php?topic=94986.0 Make example for this keyboard (after setting up your build environment): make mxss:default -See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. - -# Front LED Operation +Flashing example for this keyboard: -The MxSS PCB has 2 front RGB LEDs which has a separate brightness and mode of operation to the rest of the RGB LEDs. These are controlled through the supplied custom keycodes. + make mxss:default:flash -There are 3 modes of operation: +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). - - FLED_OFF - Front LEDs stay off - - FLED_RGB - Front LEDs are part of the standard RGB LED modes, only works correctly with rainbow modes (will fix on request) - - FLED_INDI - Top front LED represents Caps Lock status, bottom LED represents current layer - -Colors for FLED_INDI mode are hardcoded as hue/saturation values, the caps lock color can be found in mxss_frontled.h, the layer colors are defined in keymap.c (see default/keymap.c for example). +## Bootloader -## Custom Keycodes +Enter the bootloader in 2 ways: - - FLED_MOD - Cycle between the 3 modes (FLED_OFF -> FLED_RGB -> FLED_INDI) - - FLED_VAI - Increase front LED brightness - - FLED_VAD - Decrease front LED brightness +* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard +* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available |