summaryrefslogtreecommitdiff
path: root/keyboards/helix/rev2/keymaps/default/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/helix/rev2/keymaps/default/readme.md')
-rw-r--r--keyboards/helix/rev2/keymaps/default/readme.md36
1 files changed, 24 insertions, 12 deletions
diff --git a/keyboards/helix/rev2/keymaps/default/readme.md b/keyboards/helix/rev2/keymaps/default/readme.md
index 2cdc5506ca..c618c47525 100644
--- a/keyboards/helix/rev2/keymaps/default/readme.md
+++ b/keyboards/helix/rev2/keymaps/default/readme.md
@@ -108,17 +108,16 @@
see `qmk_firmware/keyboards/helix/rev2/keymaps/default/rules.mk`
```
-# Helix keyboard customize
-# you can edit follows 7 Variables
-# jp: 以下の7つの変数を必要に応じて編集します。
-HELIX_ROWS = 5 # Helix Rows is 4 or 5
-OLED_ENABLE = no # OLED_ENABLE
-LOCAL_GLCDFONT = no # use each keymaps "helixfont.h" insted of "common/glcdfont.c"
-LED_BACK_ENABLE = no # LED backlight (Enable WS2812 RGB underlight.)
-LED_UNDERGLOW_ENABLE = no # LED underglow (Enable WS2812 RGB underlight.)
-LED_ANIMATIONS = yes # LED animations
-IOS_DEVICE_ENABLE = no # connect to IOS device (iPad,iPhone)
-
+# Helix Spacific Build Options
+# you can uncomment and edit follows 7 Variables
+# jp: 以下の7つの変数を必要に応じて編集し、コメントアウトをはずします。
+# HELIX_ROWS = 5 # Helix Rows is 4 or 5
+# OLED_ENABLE = no # OLED_ENABLE
+# LOCAL_GLCDFONT = no # use each keymaps "helixfont.h" insted of "common/glcdfont.c"
+# LED_BACK_ENABLE = no # LED backlight (Enable WS2812 RGB underlight.)
+# LED_UNDERGLOW_ENABLE = no # LED underglow (Enable WS2812 RGB underlight.)
+# LED_ANIMATIONS = yes # LED animations
+# IOS_DEVICE_ENABLE = no # connect to IOS device (iPad,iPhone)
```
## Compile
@@ -130,11 +129,24 @@ $ cd qmk_firmware
build
```
$ make helix:default
+$ make helix/rev2/back:default # with backlight
+$ make HELIX=no_ani helix/rev2/back:default # with backlight without animation
+$ make helix/rev2/under:default # with underglow
+$ make helix/rev2/oled:default # with oled
+$ make helix/rev2/oled/back:default # with oled and backlight
+$ make helix/rev2/oled/under:default # with oled and underglow
```
flash to keyboard
```
-$ make helix:default:avrdude
+$ make helix:default:flash
+$ make helix/rev2/back:default:flash # with backlight
+$ make HELIX=no_ani helix/rev2/back:default:flash # with backlight without animation
+$ make helix/rev2/under:default:flash # with underglow
+$ make helix/rev2/oled:default:flash # with oled
+$ make helix/rev2/oled/back:default:flash # with oled and backlight
+$ make helix/rev2/oled/under:default:flash # with oled and underglow
+
```
## Link