summaryrefslogtreecommitdiffstats
path: root/keyboards/moonlander/readme.md
diff options
context:
space:
mode:
authorDrashna Jaelre <drashna@live.com>2020-08-22 07:44:42 -0700
committerGitHub <noreply@github.com>2020-08-22 07:44:42 -0700
commit220b1c9db40d95271dcdd8d8050e46a2a3143c65 (patch)
treef98a2177f5ec0009df4400cfd5b100a3ff816297 /keyboards/moonlander/readme.md
parent346bfb2a052f4e05cc91e55e1317c8529c405ac6 (diff)
[Keyboard] Add ZSA Moonlander (#9853)
Diffstat (limited to 'keyboards/moonlander/readme.md')
-rw-r--r--keyboards/moonlander/readme.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/keyboards/moonlander/readme.md b/keyboards/moonlander/readme.md
new file mode 100644
index 0000000000..7ddfdb84a7
--- /dev/null
+++ b/keyboards/moonlander/readme.md
@@ -0,0 +1,28 @@
+# Moonlander
+
+![Moonlander](https://zsa.io/static/gallery-white-case-7a2ef555f8f7f4ce1b9030477b16e517.png)
+
+A next-gen split, ergonomic keyboard with an active left side, USB type C, integrated wrist rest, and a thumb cluster that can move.
+
+
+* Keyboard Maintainer: [drashna](https://github.com/drashna), [ZSA](https://github.com/zsa/)
+* Hardware Supported: Moonlander MK 1 (STM32F303xC)
+* Hardware Availability: [ZSA Store](https://zsa.io/moonlander/)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make moonlander:default
+
+Flashing example for this keyboard:
+
+ make moonlander:default:flash
+
+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
+
+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`.
+
+This changes the `RGB_TOG` keycode so that it will toggle the lights on and off, in a way that will allow the Smart LEDs to continue to work, even with the rest of the LEDs turned off.
+
+Additionally, a new keycode has been added to toggle the Smart LEDs. Use `TOGGLE_LAYER_COLOR`, if you aren't already.