qmk_firmware

QMK firmware for my keyboards (Corne, Sweep Ferris) and trackball (Ploopy Adept)
Log | Files | Refs | Submodules | LICENSE

readme.md (1471B)


      1 # splaytoraid
      2 
      3 ![splaytoraid](https://i.imgur.com/N85DPHGh.png)
      4 
      5 A 40% ergonomic keyboard with a stacked acrylic case and RGB underglow.
      6 
      7 * Keyboard Maintainer: [freya](https://github.com/freya-irl)
      8 * Hardware Supported: PCB kit and Pro Micro compatible controller
      9 * Hardware Availability: [here](https://keeb.supply/products/splaytoraid-messenger-edition)
     10 
     11 Make example for this keyboard (after setting up your build environment):
     12 
     13     make 0xcb/splaytoraid:default
     14     
     15 Flashing example for this keyboard:
     16 
     17     make 0xcb/splaytoraid:default:flash
     18 
     19 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).
     20 
     21 ## Bootloader
     22 
     23 Enter the bootloader in 3 ways:
     24 
     25 * **Bootmagic reset**: Hold down the left top 4. col key (usually Escape) and plug in the keyboard
     26 * **Physical reset button**: Press the button on the controller (Helios) for more than 500ms or just press it (Pluto)
     27 * **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available
     28 
     29 When using an AVR microcontroller with this keyboard, the bootloader is configured to be QMK DFU for compatibility with [0xCB Pluto](https://github.com/0xCB-dev/0xCB-Pluto). If your microcontroller does not use this bootloader, ensure to set this parameter appropriately in your keymap's `rules.mk` file.