00ca362826
* Initial tidying up of top level helix/ directory Align readme.md with template & provide more detailed PCB information Remove unused rules.mk Add common config.h file Update glcdfont.c with formatting and license header * Further migrations after PRs merged Move shared configuration to top level info.json and config.h More descriptive hardware compatibility * Add changelog * Align configuration between PCBs - Migrate beta & pico to use RGB Matrix - Move previously RGB Matrix-dependent OLED code in rev3/rev3.c to top level - Remove reundant OLED code in beta/beta.c - Remove RGBLight references * Update changelog with RGB Matrix configuration
45 lines
1.7 KiB
Markdown
45 lines
1.7 KiB
Markdown
# Helix
|
|
|
|
|
|
|
|
* Keyboard Maintainer: [MakotoKurauchi](https://github.com/MakotoKurauchi)
|
|
* Hardware Supported: Helix Pico, Beta, rev3 PCBs w/ Pro Micro compatible development board
|
|
* Hardware Availability: [Yushakobo](https://shop.yushakobo.jp), [GitHub](https://github.com/MakotoKurauchi/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
|
|
|
|
Make example for this keyboard (after setting up your build environment):
|
|
|
|
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`
|