qmk_firmware

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

readme.md (1722B)


      1 # Helix
      2 
      3 ![image](https://i.imgur.com/11o4MRV.jpeg)
      4 
      5 * Keyboard Maintainer: [MakotoKurauchi](https://github.com/MakotoKurauchi)
      6 * Hardware Supported: Helix Pico, Beta, rev3 PCBs w/ Pro Micro compatible development board
      7 * Hardware Availability: [Yushakobo](https://shop.yushakobo.jp), [GitHub](https://github.com/MakotoKurauchi/helix)
      8 
      9 ## Revisions
     10 - [Pico](https://shop.yushakobo.jp/products/helixpico-pcb)
     11     - 4 row PCB
     12     - per-key RGB
     13     - support for a 128x32 OLED display
     14     - footprint for speaker
     15 - [Beta](https://shop.yushakobo.jp/products/oss_pcb?variant=39452554231969)
     16     - 4 or 5 row PCB with snappable bottom row
     17     - per-key RGB
     18     - support for a 128x32 OLED display
     19 - [rev3](https://shop.yushakobo.jp/products/2143)
     20     - 4 or 5 row PCB with snappable bottom row
     21     - per-key RGB
     22     - support for a 128x32 OLED display
     23     - rotary encoders
     24 
     25 Make example for this keyboard (after setting up your build environment):
     26 
     27     make helix/pico:default
     28     make helix/beta:default
     29     make helix/rev3:default
     30 
     31 Flashing example for this keyboard:
     32 
     33     make helix/pico:default:flash
     34     make helix/beta:default:flash
     35     make helix/rev3:default:flash
     36 
     37 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).
     38 
     39 ## Bootloader
     40 
     41 Enter the bootloader in 3 ways:
     42 
     43 * **Bootmagic reset**: Hold down the key at (0,0) in the matrix and plug in the keyboard
     44 * **Physical reset button**: Briefly tap or double-tap the button near the TRRS jack
     45 * **Keycode in layout**: Press the key mapped to `QK_BOOT`