diff options
Diffstat (limited to 'keyboards/helix/readme.md')
-rw-r--r-- | keyboards/helix/readme.md | 51 |
1 files changed, 40 insertions, 11 deletions
diff --git a/keyboards/helix/readme.md b/keyboards/helix/readme.md index 0c190f7626..0812271102 100644 --- a/keyboards/helix/readme.md +++ b/keyboards/helix/readme.md @@ -1,16 +1,45 @@ -Helix -=== +# Helix - + -A compact split ortholinear keyboard. +* Keyboard Maintainer: [MakotoKurauchi](https://github.com/MakotoKurauchi) +* Hardware Supported: Helix Pico, Beta, rev3 PCBs +* Hardware Availability: [Yushakobo](https://shop.yushakobo.jp), [GitHub](https://github.com/MakotoKurauchi/helix) -Keyboard Maintainer: [Makoto Kurauchi](https://github.com/MakotoKurauchi/) [@pluis9](https://twitter.com/pluis9) [yushakobo](https://github.com/yushakobo) -Hardware Supported: Helix PCB Alpha, Beta, Rev3, Pro Micro -Hardware Availability: [PCB & Case Data](https://github.com/MakotoKurauchi/helix), [Yushakobo Shop](https://yushakobo.jp/shop/), [Little Keyboards](https://littlekeyboards.com/collections/helix) +## Revisions +- [Pico](https://shop.yushakobo.jp/products/helixpico-pcb) + - 4 row PCB + - per-key RGB + - support for a 128x32 OLED display + - footprint for speaker +- [Beta](https://shop.yushakobo.jp/products/oss_pcb?variant=39452554231969) + - 4 or 5 row PCB with snappable bottom row + - per-key RGB + - support for a 128x32 OLED display +- [rev3](https://shop.yushakobo.jp/products/2143) + - 4 or 5 row PCB with snappable bottom row + - per-key RGB + - support for a 128x32 OLED display + - rotary encoders -## How to build - * [Helix how to Customize and Compile](rev2/keymaps/default/readme.md#customize) - * [HelixPico how to Customize and Compile](pico/keymaps/default/readme.md#customize) +Make example for this keyboard (after setting up your build environment): -See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. + make helix/pico:default + make helix/beta:default + make helix/rev3:default + +Flashing example for this keyboard: + + make helix/pico:default:flash + make helix/beta:default:flash + make helix/rev3: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 key at (0,0) in the matrix and plug in the keyboard +* **Physical reset button**: Briefly tap or double-tap the button near the TRRS jack +* **Keycode in layout**: Press the key mapped to `QK_BOOT` |