summaryrefslogtreecommitdiff
path: root/keyboards/helix/rev2/readme.md
diff options
context:
space:
mode:
authorMakotoKurauchi <pluis@me.com>2020-12-15 20:14:14 +0900
committerGitHub <noreply@github.com>2020-12-15 20:14:14 +0900
commit0831a3181a51cf190aabcea504c1be2752bbc2be (patch)
tree5cedc6e0876ed6f121ec361e98a62ee8f851e783 /keyboards/helix/rev2/readme.md
parentac8cddda22aa0abc4f41405c7f94a56dc533dfc4 (diff)
[Keymap] Helix default keymap oled update (#11152)
* update keyboards/helix/rev2/local_features.mk - Improved parsing of the `HELIX =` option * add 'is_mac_mode()' into keyboards/helix/rev2/rev2.c * update helix/rev2/keymaps/default/keymap.c: use rgblight query functions * Makes the OLED driver used by the helix:default keymap switchable. * use TOP/drivers/oled/oled_driver.c `make helix:default` or `make OLED_SELECT=core helix:default` * use helix/local_drivers/ssd1306.c `make OLED_SELECT=local helix:default` * Separated the OLED related code from keymap.c and moved it to oled_display.c. * Change the 'led_test' keymap to follow the changes in the 'default' keymap. * update helix/rev2/keymaps/default/oled_display.c * add '#define OLED_UPDATE_INTERVAL 50' into keyboards/helix/rev2/config.h * Support for OLED_UPDATE_INTERVAL, even for older types of OLED tasks * add readme.md for helix/rev2 * Apply drashna's suggestions to rev2.c. * Apply drashna's suggestions to rev3_4rows.c, rev3_5rows.c. Co-authored-by: mtei <2170248+mtei@users.noreply.github.com>
Diffstat (limited to 'keyboards/helix/rev2/readme.md')
-rw-r--r--keyboards/helix/rev2/readme.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/keyboards/helix/rev2/readme.md b/keyboards/helix/rev2/readme.md
new file mode 100644
index 0000000000..e6a6f2e952
--- /dev/null
+++ b/keyboards/helix/rev2/readme.md
@@ -0,0 +1,13 @@
+# Helix rev2
+
+A compact split ortholinear keyboard.
+
+* Keyboard Maintainer: [yushakobo](https://github.com/yushakobo)
+* Hardware Supported: Helix rev2 PCBs, Pro Micro
+* Hardware Availability: [PCB & Case Data](https://github.com/MakotoKurauchi/helix)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make helix/rev2: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).