summaryrefslogtreecommitdiffstats
path: root/keyboards/mxss/readme.md
diff options
context:
space:
mode:
authorJumail Mundekkat <mundekkat@hotmail.com>2020-01-27 09:06:56 +1100
committerridingqwerty <george.g.koenig@gmail.com>2020-01-26 17:06:56 -0500
commit645c5fabf24411fe65d2172a3509c26e053651a2 (patch)
treebbba022ea3e1a9605f80fc4ca97c991dc941d4ed /keyboards/mxss/readme.md
parent7f7b6b08e8afdd09f83b180e4c03b04f9a531035 (diff)
Add VIA support to MxSS, plus minor tweaks (#7809)
* Add VIA support to mxss and general cleanup * Add support for RGB test for FLEDs * Add LAYOUT_all to allow for more configuration * Remove blank layers * Updated readme * Improve use of EEPROM * Credit where its due * Use the latest iteration of rgblight code * Keep the RGB timer running if the front LED is in RGB mode * Fix RGB breathing animation * Better supported RGB animation Only thing not working is alternating, but that's not too important * Abstract front LED handlers from main kb code * Add support for indicator LED color changing * Remove debug statement * Persist indicator LED colors * Mark custom sections in rgblight.c * Light commenting * Fix up keymaps * Add/update comments * Remove bloat from default hex * Tidy a stray tab * Out with the old, in with the new * Out with the old, in with the new * Add LAYER_STATE_8BIT for VIA keymap
Diffstat (limited to 'keyboards/mxss/readme.md')
-rw-r--r--keyboards/mxss/readme.md7
1 files changed, 6 insertions, 1 deletions
diff --git a/keyboards/mxss/readme.md b/keyboards/mxss/readme.md
index 181b6366a0..f35709adee 100644
--- a/keyboards/mxss/readme.md
+++ b/keyboards/mxss/readme.md
@@ -2,6 +2,11 @@
![MxSS - Polycarb 65% Kit for MX/SMK](https://i.imgur.com/WDTWcmU.jpg)
+### 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
@@ -51,4 +56,4 @@ Colors for FLED_INDI mode are hardcoded as hue/saturation values, the caps lock
# Further Notes
- As SAFE_RANGE is used for defining the custom keycodes seen above, please use NEW_SAFE_RANGE as the starting value for any custom keycodes in keymap.c, as per the example. \ No newline at end of file
+ As SAFE_RANGE is used for defining the custom keycodes seen above, please use NEW_SAFE_RANGE as the starting value for any custom keycodes in keymap.c, as per the example.