Update the firmware section of each keyboard

corne-cherry/doc/v2/buildguide_jp.md

@@ -36,8 +36,8 @@
 ![01](https://user-images.githubusercontent.com/736191/54487431-789a6c00-48d9-11e9-9390-a8510b19ba34.jpg)
 
 ## 事前準備
-実装の途中でProMicroにファームを入れる作業がありますが、ファームをビルドする環境を整備するのは時間がかかるのではじめに取り掛かっておくことをおすすめします。
+ファームウェアを自分でビルドする場合は環境を整備するのに時間がかかるのではじめに取り掛かっておくことをおすすめします。\
-https://docs.qmk.fm/#/newbs_getting_started こちら等を参考にし、OSに合わせて必要なものをインストールしておきます(インストールに時間がかかるため動かしつつ実装を進めると効率的です)。
+詳しくは https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md を参照してください。
 
 ## 実装
 
@@ -150,35 +150,8 @@ ProMicroとOLEDモジュールを付けた段階で動作確認をすること
 ![20](https://user-images.githubusercontent.com/736191/54487451-7afcc600-48d9-11e9-8c90-2f2919bf9483.jpg)
 
 ## ファームウェア
-https://docs.qmk.fm/#/newbs_getting_started こちらを参照して頂き、ファームウェアを書き込む環境を用意します。
+下記を参照しファームウェアをProMicroに書き込みます。\
-
+https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md
-環境ができましたら、下記コマンドで Crkbd 用にファームウェアをビルドします。
-
-```
-make crkbd:default
-```
-
-ビルドが完了したら下記コマンドを実行します。
-
-```
-make crkbd:default:avrdude
-```
-
-実行すると下記のようなログがでて、`.` が増えていくことが確認出来ると思います。
-この間にリセットスイッチを **2回** 押すとファームウェアの書き込みが完了します。
-
-```
-<省略>
-
-Checking file size of crkbd_rev1_default.hex                                                        [OK]
- * File size is fine - 27328/28672
-Copying crkbd_rev1_default.hex to qmk_firmware folder                                               [OK]
-Detecting USB port, reset your controller now........
-```
-
-片側のProMicroにファームウェアの書き込みが完了したら、もう片方も同じ手順で書き込みを行います。
-
-以上で完成です。
 
 ## LED（オプション）
 SK6812MINIを取り付けていきます。

corne-cherry/doc/v3/buildguide_jp.md

@@ -36,10 +36,8 @@
 | WS2812B | 12個 | Undergrow 用 LEDs |
 
 ## 事前準備
-組み立ての途中で ProMicro にファームウェアを入れる作業がありますが、ファームウェアをビルドする環境を整備するのには時間がかかるためはじめに取り掛かっておくことをおすすめします。
+ファームウェアを自分でビルドする場合は環境を整備するのに時間がかかるのではじめに取り掛かっておくことをおすすめします。\
-
+詳しくは https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md を参照してください。
-https://docs.qmk.fm/#/ja/newbs_getting_started を参考にし、OSに合わせて必要なものをインストールしておきます。
-インストールに時間がかかるため動かしつつ組み立てを進めると効率的です。
 
 ## 確認
 
@@ -165,54 +163,9 @@ OLED用のピンソケットにピンヘッダを先に差し込み、その後
 
 ![build_oled](assets/build_oled.jpg)
 
-### ファームウェア
+## ファームウェア
-https://docs.qmk.fm/#/ja/newbs_getting_started こちら等を参考にし、OSに合わせて必要なものをインストールしておきます。
+下記を参照しファームウェアをProMicroに書き込みます。\
-上記の事前準備にも挙げたとおり、インストールに時間がかかるため事前に用意しておくことをおすすめします。
+https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md
-
-Corne 用のファームウェアは `keyboards/crkbd` です。
-なお、LEDはデフォルトでは無効になっているため、`keyboards/crkbd/rules.mk` にて `RGBLIGHT_ENABLE = yes` と変更する必要があります。
-
-```diff
-diff --git a/keyboards/crkbd/rules.mk b/keyboards/crkbd/rules.mk
-index 30de5b388..174dd5c7e 100644
---- a/keyboards/crkbd/rules.mk
-+++ b/keyboards/crkbd/rules.mk
-@@ -26,7 +26,7 @@ MIDI_ENABLE = no            # MIDI controls
- AUDIO_ENABLE = no           # Audio output on port C6
- UNICODE_ENABLE = no         # Unicode
- BLUETOOTH_ENABLE = no       # Enable Bluetooth with the Adafruit EZ-Key HID
--RGBLIGHT_ENABLE = no       # Enable WS2812 RGB underlight.
-+RGBLIGHT_ENABLE = yes       # Enable WS2812 RGB underlight.
-
- # Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
- SLEEP_LED_ENABLE = no    # Breathing sleep LED during USB suspend
-```
-
-環境ができたら、下記コマンドでファームウェアをビルドします。
-
-```bash
-make crkbd:default
-```
-
-ビルドが完了したら下記コマンドを実行します。
-
-```bash
-make crkbd:default:avrdude
-```
-
-実行すると下記のようなログがでて、`.` が増えていくことが確認出来ると思います。
-この間にリセットスイッチを **2回** 押すとファームウェアの書き込みが完了します。
-
-```bash
-<省略>
-
-Checking file size of crkbd_rev1_default.hex                                                        [OK]
- * File size is fine - 27328/28672
-Copying crkbd_rev1_default.hex to qmk_firmware folder                                               [OK]
-Detecting USB port, reset your controller now........
-```
-
-片側のProMicroにファームウェアの書き込みが完了したら、もう片方も同じ手順で書き込みを行います。
 
 ### 動作確認
 ProMicroとOLEDモジュールを付けた段階で動作確認をすることをおすすめします。

corne-chocolate/doc/buildguide_en.md

@@ -37,10 +37,8 @@ This is the build guide for Corne Chocolate.
 | SK6812MINI | 54 | 42 for backlight, 12 for under-glow |
 
 ## Preparation
-
+If you build the firmware yourself, it will take some time to set up the environment, so it's best to start at the beginning. \
-It is recommended to [flash the firmware](#firmware) onto the Pro Micro before doing anything else,
+For more information, please see https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md.
-as it is time-consuming to prepare the environment for building it,
-and doing it in the middle of the soldering process is a hassle.
 
 ## Building
 
@@ -254,41 +252,8 @@ because it looks better.
 ![](https://user-images.githubusercontent.com/736191/52534914-00e19a80-2d8b-11e9-8005-7e0b157e09e4.png)
 
 ## Firmware
-
+See below to flash the firmware to the ProMicro. \
-Refer to [the QMK _getting started_ guide](https://docs.qmk.fm/#/newbs_getting_started),
+https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md
-and install the necessary software according to your OS
-(it takes quite some time to install).
-
-Once the environment is ready,
-build the firmware for Crkbd with the following command.
-
-```
-make crkbd: default
-```
-
-When the build is completed,
-execute the following command.
-
-```
-make crkbd: default: avrdude
-```
-
-When you execute it,
-you will see the following log,
-and you can progress by `.`s appearing.
-Press the reset switch **twice** during this time to complete the firmware writing.
-
-```
-<Omitted>
-
-Checking file size of crkbd_rev1_default.hex [OK]
- * File size is fine-27328/28672
-Copying crkbd_rev1_default.hex to qmk_firmware folder [OK]
-Detecting USB port, reset your controller now ........
-```
-
-Once the firmware has been written to one side of the Pro Micro,
-follow the same procedure for the other side.
 
 This is the end.
 

corne-chocolate/doc/buildguide_jp.md

@@ -34,8 +34,8 @@
 | SK6812MINI | 54個 | 上向き実装 42個、下向き実装 12個 |
 
 ## 事前準備
-実装の途中でProMicroにファームを入れる作業がありますが、ファームをビルドする環境を整備するのは時間がかかるのではじめに取り掛かっておくことをおすすめします。
+ファームウェアを自分でビルドする場合は環境を整備するのに時間がかかるのではじめに取り掛かっておくことをおすすめします。\
-https://docs.qmk.fm/#/newbs_getting_started こちら等を参考にし、OSに合わせて必要なものをインストールしておきます(インストールに時間がかかるため動かしつつ実装を進めると効率的です)。
+詳しくは https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md を参照してください。
 
 ## 実装
 
@@ -191,33 +191,8 @@ LEDは４つずつはんだづけを行いますが、一度に４つ行わず
 ![33](https://user-images.githubusercontent.com/736191/52534914-00e19a80-2d8b-11e9-8005-7e0b157e09e4.png)
 
 ## ファームウェア
-https://docs.qmk.fm/#/newbs_getting_started こちらを参照して頂き、ファームウェアを書き込む環境を用意します。
+下記を参照しファームウェアをProMicroに書き込みます。\
-
+https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md
-環境ができましたら、下記コマンドで Crkbd 用にファームウェアをビルドします。
-
-```
-make crkbd:default
-```
-
-ビルドが完了したら下記コマンドを実行します。
-
-```
-make crkbd:default:avrdude
-```
-
-実行すると下記のようなログがでて、`.` が増えていくことが確認出来ると思います。
-この間にリセットスイッチを **2回** 押すとファームウェアの書き込みが完了します。
-
-```
-<省略>
-
-Checking file size of crkbd_rev1_default.hex                                                        [OK]
- * File size is fine - 27328/28672
-Copying crkbd_rev1_default.hex to qmk_firmware folder                                               [OK]
-Detecting USB port, reset your controller now........
-```
-
-片側のProMicroにファームウェアの書き込みが完了したら、もう片方も同じ手順で書き込みを行います。
 
 以上で完成です。
 

corne-classic/doc/buildguide_en.md

@@ -29,6 +29,10 @@
 
 ![image](https://user-images.githubusercontent.com/736191/40734610-e1ca0136-6473-11e8-8ac7-7bfa4b843f93.png)
 
+## Preparation
+If you build the firmware yourself, it will take some time to set up the environment, so it's best to start at the beginning. \
+For more information, please see https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md.
+
 ## Soldering
 
 PCB is reversible; use one for the left hand side and the other for the right.
@@ -193,34 +197,8 @@ Lastly install keycaps.
 
 
 ## Firmware
-Setup firmware build environment following the instructions here:
+See below to flash the firmware to the ProMicro. \
-https://docs.qmk.fm/#/newbs_getting_started
+https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md
-
-Then build firmware for Crkbd with this command:
-
-```
-make crkbd:default
-```
-
-To flash the firmware image you have just built, execute this:
-
-```
-make crkbd:default:avrdude
-```
-
-You will see `.` after a message like below.
-While you see `.` is being printed on the screen, push the reset switch __twice__.
-
-```
-(snip)
-
-Checking file size of crkbd_rev1_default.hex                                                        [OK]
- * File size is fine - 27328/28672
-Copying crkbd_rev1_default.hex to qmk_firmware folder                                               [OK]
-Detecting USB port, reset your controller now........
-```
-
-Flash the firmware to the other side as well.
 
 ### Turning LEDS on
 To turn the LEDs on, you have to edit the `rules.mk` file. If you use the default layout, it can be found here `keyboards/crkbd/keymaps/default/rules.mk`. Add the following line to the top of the file:

corne-classic/doc/buildguide_jp.md

@@ -30,8 +30,8 @@
 ![image](https://user-images.githubusercontent.com/736191/40734610-e1ca0136-6473-11e8-8ac7-7bfa4b843f93.png)
 
 ## 事前準備
-実装の途中でProMicroにファームを入れる作業がありますが、ファームをビルドする環境を整備するのは時間がかかるのではじめに取り掛かっておくことをおすすめします。
+ファームウェアを自分でビルドする場合は環境を整備するのに時間がかかるのではじめに取り掛かっておくことをおすすめします。\
-https://docs.qmk.fm/#/newbs_getting_started こちら等を参考にし、OSに合わせて必要なものをインストールしておきます(インストールに時間がかかるため動かしつつ実装を進めると効率的です)。
+詳しくは https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md を参照してください。
 
 ## 実装
 
@@ -179,32 +179,7 @@ LEDを実装した場合はすべて点灯することを確認します。
 ![lrg_dsc03895](https://user-images.githubusercontent.com/736191/40888756-c371e264-6796-11e8-8fc5-e842e8baf2b8.png)
 
 ## ファームウェア
-https://docs.qmk.fm/#/newbs_getting_started こちらを参照して頂き、ファームウェアを書き込む環境を用意します。
+下記を参照しファームウェアをProMicroに書き込みます。\
-
+https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md
-環境ができましたら、下記コマンドで Crkbd 用にファームウェアをビルドします。
-
-```
-make crkbd:default
-```
-
-ビルドが完了したら下記コマンドを実行します。
-
-```
-make crkbd:default:avrdude
-```
-
-実行すると下記のようなログがでて、`.` が増えていくことが確認出来ると思います。
-この間にリセットスイッチを __2回__ 押すとファームウェアの書き込みが完了します。
-
-```
-<省略>
-
-Checking file size of crkbd_rev1_default.hex                                                        [OK]
- * File size is fine - 27328/28672
-Copying crkbd_rev1_default.hex to qmk_firmware folder                                               [OK]
-Detecting USB port, reset your controller now........
-```
-
-片側のProMicroにファームウェアの書き込みが完了したら、もう片方も同じ手順で書き込みを行います。
 
 以上で完成です。

corne-light/doc/v1/buildguide_jp.md

@@ -110,8 +110,8 @@
 </table>
 
 ## 事前準備
-実装の途中でProMicroにファームを入れる作業がありますが、ファームをビルドする環境を整備するのは時間がかかるのではじめに取り掛かっておくことをおすすめします。
+ファームウェアを自分でビルドする場合は環境を整備するのに時間がかかるのではじめに取り掛かっておくことをおすすめします。\
-https://docs.qmk.fm/#/newbs_getting_started こちら等を参考にし、OSに合わせて必要なものをインストールしておきます(インストールに時間がかかるため動かしつつ実装を進めると効率的です)。
+詳しくは https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md を参照してください。
 
 ## 実装
 ### PCBの切り離し
@@ -171,35 +171,8 @@ https://docs.qmk.fm/#/newbs_getting_started こちら等を参考にし、OSに
 <img alt="assembly-promicro-oled" src="https://user-images.githubusercontent.com/736191/69554644-6e427d00-0fe5-11ea-8c6b-9aaa3d2c3f6c.JPG" width="100%">
 
 ### ファームウェアの書き込み
-ProMicroとOLEDモジュールを付けた段階でファームウェアを書き込み、動作確認をすることをおすすめします(キースイッチを付けたあとに不具合が見つかると厄介です)。
+下記を参照しファームウェアをProMicroに書き込みます。\
-
+https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md
-https://docs.qmk.fm/#/newbs_getting_started こちらを参照し、ファームウェアを書き込む環境を用意します。
-
-環境ができたら下記コマンドで Crkbd 用にファームウェアをビルドします。
-
-```
-make crkbd:default
-```
-
-ビルドが完了したら下記コマンドを実行します。
-
-```
-make crkbd:default:avrdude
-```
-
-実行すると下記のようなログがでて、`.` が増えていくことが確認出来ると思います。
-この間にリセットスイッチを **2回** 押すとファームウェアの書き込みが完了します。
-
-```
-<省略>
-
-Checking file size of crkbd_rev1_default.hex                                                        [OK]
- * File size is fine - 27328/28672
-Copying crkbd_rev1_default.hex to qmk_firmware folder                                               [OK]
-Detecting USB port, reset your controller now........
-```
-
-片側のProMicroにファームウェアの書き込みが完了したら、もう片方も同じ手順で書き込みを行います。
 
 ### 動作確認
 

corne-light/doc/v2/buildguide_low_edition_jp.md

@@ -33,10 +33,8 @@
 | OLEDモジュール用ピンソケット 4連 2.5mm | 2つ | |
 
 ## 事前準備
-組み立ての途中で ProMicro にファームウェアを入れる作業がありますが、ファームウェアをビルドする環境を整備するのには時間がかかるためはじめに取り掛かっておくことをおすすめします。
+ファームウェアを自分でビルドする場合は環境を整備するのに時間がかかるのではじめに取り掛かっておくことをおすすめします。\
-
+詳しくは https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md を参照してください。
-https://docs.qmk.fm/#/ja/newbs_getting_started を参考にし、OSに合わせて必要なものをインストールしておきます。
-インストールに時間がかかるため動かしつつ組み立てを進めると効率的です。
 
 ## 確認
 
@@ -120,53 +118,8 @@ OLED用のピンソケットにピンヘッダを先に差し込み、その後
 ![build_oled](assets/build_oled.jpg)
 
 ### ファームウェア
-https://docs.qmk.fm/#/ja/newbs_getting_started こちら等を参考にし、OSに合わせて必要なものをインストールしておきます。
+下記を参照しファームウェアをProMicroに書き込みます。\
-上記の事前準備にも挙げたとおり、インストールに時間がかかるため事前に用意しておくことをおすすめします。
+https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md
-
-Corne 用のファームウェアは `keyboards/crkbd` です。
-なお、LEDはデフォルトでは無効になっているため、`keyboards/crkbd/rules.mk` にて `RGBLIGHT_ENABLE = yes` と変更する必要があります。
-
-```diff
-diff --git a/keyboards/crkbd/rules.mk b/keyboards/crkbd/rules.mk
-index 30de5b388..174dd5c7e 100644
---- a/keyboards/crkbd/rules.mk
-+++ b/keyboards/crkbd/rules.mk
-@@ -26,7 +26,7 @@ MIDI_ENABLE = no            # MIDI controls
- AUDIO_ENABLE = no           # Audio output on port C6
- UNICODE_ENABLE = no         # Unicode
- BLUETOOTH_ENABLE = no       # Enable Bluetooth with the Adafruit EZ-Key HID
--RGBLIGHT_ENABLE = no       # Enable WS2812 RGB underlight.
-+RGBLIGHT_ENABLE = yes       # Enable WS2812 RGB underlight.
-
- # Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
- SLEEP_LED_ENABLE = no    # Breathing sleep LED during USB suspend
-```
-
-環境ができたら、下記コマンドでファームウェアをビルドします。
-
-```bash
-make crkbd:default
-```
-
-ビルドが完了したら下記コマンドを実行します。
-
-```bash
-make crkbd:default:avrdude
-```
-
-実行すると下記のようなログがでて、`.` が増えていくことが確認出来ると思います。
-この間にリセットスイッチを **2回** 押すとファームウェアの書き込みが完了します。
-
-```bash
-<省略>
-
-Checking file size of crkbd_rev1_default.hex                                                        [OK]
- * File size is fine - 27328/28672
-Copying crkbd_rev1_default.hex to qmk_firmware folder                                               [OK]
-Detecting USB port, reset your controller now........
-```
-
-片側のProMicroにファームウェアの書き込みが完了したら、もう片方も同じ手順で書き込みを行います。
 
 ### 動作確認
 ProMicroとOLEDモジュールを付けた段階で動作確認をすることをおすすめします。