aboutsummaryrefslogtreecommitdiff
path: root/keyboards/helix/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/helix/readme.md')
-rw-r--r--keyboards/helix/readme.md38
1 files changed, 27 insertions, 11 deletions
diff --git a/keyboards/helix/readme.md b/keyboards/helix/readme.md
index 0c190f7626..f9b1e4daa5 100644
--- a/keyboards/helix/readme.md
+++ b/keyboards/helix/readme.md
@@ -1,16 +1,32 @@
-Helix
-===
+# Helix
-![Helix](https://i.imgur.com/XBAmynN.jpg)
+![image](https://i.imgur.com/fpHr3Bqh.jpg)
-A compact split ortholinear keyboard.
+* Keyboard Maintainer: [MakotoKurachi](https://github.com/MakotoKurauchi)
+* Hardware Supported: Pro Micro or compatible alternative with Helix PCBS
+* Hardware Availability: [Github](https://github.com/MakotoKurauchi/helix), [Yushakobo Shop](https://shop.yushakobo.jp)
-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)
+Make example for this keyboard (after setting up your build environment):
-## 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 helix/pico:default
+ make helix/rev2:default
+ make helix/rev3_4rows:default
+ make helix/rev3_5rows:default
-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.
+
+Flashing example for this keyboard:
+
+ make helix/pico:default:flash
+ make helix/rev2:default:flash
+ make helix/rev3_4rows:default:flash
+ make helix/rev3_5rows: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
+* **Physical reset button**: If using a promicro, double tap reset button (or short GND & RST pins). If using Elite-C/similar, press reset button once. If using RP2040 replacement, hold BOOT button while plugging keyboard in.
+* **Keycode in layout**: Press the key mapped to `QK_BOOT`