From e0d08f48953b89beee646fe2bb5dc40cfc5e0051 Mon Sep 17 00:00:00 2001
From: mtei <2170248+mtei@users.noreply.github.com>
Date: Tue, 20 Mar 2018 03:03:40 +0900
Subject: [PATCH] add readme.md

---
 .../helix/rev2/keymaps/default/readme.md      | 79 +++++++++++++++----
 1 file changed, 65 insertions(+), 14 deletions(-)

diff --git a/keyboards/helix/rev2/keymaps/default/readme.md b/keyboards/helix/rev2/keymaps/default/readme.md
index 02888855b8..92ba264dba 100644
--- a/keyboards/helix/rev2/keymaps/default/readme.md
+++ b/keyboards/helix/rev2/keymaps/default/readme.md
@@ -1,25 +1,76 @@
-SSD1306 OLED Display via I2C
-======
+# Helix keyboard default keymap
 
-Features
---------
+## コンパイルの仕方
 
-Some features supported by the firmware:
+コンパイルは、qmk_firmware のトップディレクトリで行います。
 
+```
+$ cd qmk_firmware
+```
+qmk_firmwareでは各キーボードのコンパイルは、`<キーボード名>:<キーマップ名>`という指定で行います。
 
-* I2C connection between the two halves is required as the OLED display will use this connection as well. Note this
-  requires pull-up resistors on the data and clock lines.
-* OLED display will connect from either side
+```
+$ make helix:default
+```
 
+キーボードへの書き込みまで同時に行うには下記のように`:avrdude`を付けます。
 
-Wiring
-------
+```
+$ make helix:default:avrdude
+```
 
+コンパイル結果と中間生成物を消去したい場合は以下のようにします。
 
-Work in progress...
+```
+$ make helix:default:clean
+```
 
+## カスタマイズ
 
-OLED Configuration
--------------------------------
+Helix キーボードを4行版として製作したり、オプションの OLED をつけたり、
+RGB バックライトまたは、RGB Underglow をつけた場合は、
+`qmk_firmware/keyboards/helix/rev2/keymaps/default/rules.mk` の以下の部分を編集して機能を有効化してください。
 
-Work in progress...
+```
+# Helix keyboard customize
+# you can edit follows 5 Variables
+#  jp: 以下の5つの変数を必要に応じて編集します。
+HELIX_ROWS = 5              # Helix Rows is 4 or 5
+OLED_ENABLE = no            # OLED_ENABLE
+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
+
+```
+
+## 4行版Helix に対応する
+
+rules.mk の下記の部分を編集して 5 を 4 に変更してください。
+
+```
+HELIX_ROWS = 4              # Helix Rows is 4 or 5
+```
+
+## RGB バックライトを有効にする
+
+rules.mk の下記の部分を編集して no を yes に変更してください。
+
+```
+LED_BACK_ENABLE = yes        # LED backlight (Enable WS2812 RGB underlight.)
+```
+
+## RGB Underglow を有効にする
+
+rules.mk の下記の部分を編集して no を yes に変更してください。
+```
+LED_UNDERGLOW_ENABLE = yes   # LED underglow (Enable WS2812 RGB underlight.)
+```
+
+## OLEDを有効にする
+
+rules.mk の下記の部分を編集して no を yes に変更してください。
+```
+OLED_ENABLE = yes            # OLED_ENABLE
+```
+
+さらに詳細は、[こちら](https://github.com/MakotoKurauchi/helix/blob/master/Doc/firmware_jp.md)をご覧ください。