diff options
Diffstat (limited to 'keyboards/0xcb/splaytoraid/readme.md')
| -rw-r--r-- | keyboards/0xcb/splaytoraid/readme.md | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/keyboards/0xcb/splaytoraid/readme.md b/keyboards/0xcb/splaytoraid/readme.md new file mode 100644 index 0000000000..ab53696c95 --- /dev/null +++ b/keyboards/0xcb/splaytoraid/readme.md @@ -0,0 +1,36 @@ +# splaytoraid + + + +A 40% ergonomic keyboard with a stacked acrylic case and RGB underglow. + +* Keyboard Maintainer: [freya](https://github.com/freya-irl) +* Hardware Supported: PCB kit and Pro Micro compatible controller +* Hardware Availability: [here](https://keeb.supply/products/splaytoraid-messenger-edition) + +Make example for this keyboard (after setting up your build environment): + + make 0xcb/splaytoraid:default + make 0xcb/splaytoraid/32u4:default + +Flashing example for this keyboard: + + make 0xcb/splaytoraid:default:flash + make 0xcb/splaytoraid/32u4: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). + +## Bootloader + +Enter the bootloader in 3 ways: + +* **Bootmagic reset**: Hold down the left top 4. col key (usually Escape) and plug in the keyboard +* **Physical reset button**: Press the button on the controller (Helios) for more than 500ms or just press it (Pluto) +* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available + +Please note that the default bootloader for the `32u4` version is QMK DFU, for compatibility with [0xCB Pluto](https://github.com/0xCB-dev/0xCB-Pluto). Generic Pro Micros often use a different bootloader, such as `caterina`. + +If the incorrect bootloader is specified, bootmagic reset and the `QK_BOOT` keycode will not work. + +To avoid this problem, set the correct bootloader in your custom keymap's `rules.mk` file before compiling, or flash using an appropriate target (ex: `make 0xcb/splaytoraid/32u4:default:avrdude`). See [flashing instructions and bootloader information](https://docs.qmk.fm/#/flashing) for more details. |