Update firmware documentations

doc/firmware_en.md

@@ -0,0 +1,124 @@
+
+# Firmware
+
+## Flash the firmware
+
+There are several ways to flash the firmware, but using [QMK Toolbox] (https://github.com/qmk/qmk_toolbox) is the easiest way.
+
+### Download QMK Toolbox
+Download QMK Toolbox from the following link.\
+https://github.com/qmk/qmk_toolbox/releases/
+
+![qmk_toolbox_download](assets/qmk_toolbox_download.jpg)
+
+Install QMK Toolbox from the downloaded file. \
+Follow the instructions for each operating system for installation.
+
+Open QMK Toolbox, you will see a window like the one below.
+
+![qmk_toolbox_begin](assets/qmk_toolbox_begin.jpg)
+
+### Flash the firmware
+
+Download the firmware of VIA from the following link.\
+[crkbd_rev1_common_via.hex](https://github.com/foostan/qmk_firmware-hex/releases/download/release-20201103/crkbd_rev1_common_via.hex)
+
+Specify the file downloaded from "**Open**" in QMK Toolbox.
+And enable the check box for "**Auto-Flash**".
+
+![qmk_toolbox_flash](assets/qmk_toolbox_flash.jpg)
+
+With the keyboard connected via USB, press the reset button to start flashing the firmware. \
+If you see the message, it's done.
+
+![qmk_toolbox_flashed](assets/qmk_toolbox_flashed.jpg)
+
+Once the firmware has been written to one side of the Pro Micro,
+follow the same procedure for the other side.
+
+### (Optional) If you build the firmware yourself
+
+Refer to [the QMK _getting started_ guide](https://docs.qmk.fm/#/newbs_getting_started),
+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/rev1/common:via
+```
+
+When the build is completed,
+execute the following command.
+
+```
+make crkbd/rev1/common:via: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.
+Depending on the ProMicro, it may be one time.
+
+```
+<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.
+
+## Change your keymap
+
+The Corne Keyboard is supported by [VIA](https://caniusevia.com/). \
+It can be used by flashing the firmware for VIA as described above.
+
+### Download VIA
+
+Download VIA from the following link.\
+https://github.com/the-via/releases/releases/
+
+![via_download](assets/via_download.jpg)
+
+Install VIA from the downloaded file. \
+Follow the instructions for each operating system for installation.
+
+When VIA is opened with the keyboard plugged in, the following window will appear.
+
+![via_begin](assets/via_begin.jpg)
+
+### KEYMAP / CONFIGURE
+
+In this screen, you can change the key map.
+
+There are several types of keys that can be changed and you can find them in the "1" area.
+If you want to change the key, click on "2" to change the key and "3" to select the key you want to change.
+VIA instantly changes the keymap.
+
+![via_keymap_configure](assets/via_keymap_configure.jpg)
+
+### KEYMAP / TESTER
+
+In this screen, you can test the operation of the keymap.
+
+You can confirm that the key is set correctly by checking that the color of the key you press changes.
+
+![via_keymap_tester](assets/via_keymap_tester.jpg)
+
+Test Matrix allows you to check the operation of each switch on the keyboard.
+It is easier to check the operation of each switch after build.
+
+![via_keymap_tester_matrix](assets/via_keymap_tester_matrix.jpg)
+
+### LIGHTING
+
+In this screen, you can change the pattern and color of the LEDs.
+
+![via_lighitng](assets/via_lighting.jpg)
+

doc/firmware_jp.md

@@ -0,0 +1,113 @@
+# ファームウェア
+
+## ファームウェアの書き込み
+
+ファームウェアの書き込み方法はいくつか用意されていますが、[QMK Toolbox](https://github.com/qmk/qmk_toolbox) を利用する方法が手軽です。
+
+### QMK Toolbox のダウンロード
+下記のURLから最新版の QMK Toolbox をダウンロードします。\
+https://github.com/qmk/qmk_toolbox/releases/
+
+![qmk_toolbox_download](assets/qmk_toolbox_download.jpg)
+
+ダウンロードしたファイルから QMK Toolbox をインストールします。\
+インストール方法は各OSの指示に従ってください。
+
+QMK Toolbox を開くと下記のようなウィンドウが表示されます。
+
+![qmk_toolbox_begin](assets/qmk_toolbox_begin.jpg)
+
+### ファームウェアの書き込み
+
+VIA用のファームウェアを下記よりダウンロードします。\
+[crkbd_rev1_common_via.hex](https://github.com/foostan/qmk_firmware-hex/releases/download/release-20201103/crkbd_rev1_common_via.hex)
+
+QMK Toolbox の 「**Open**」 からダウンロードしたファイルを指定します。\
+また「**Auto-Flash**」のチェックボックスをチェックします。
+
+![qmk_toolbox_flash](assets/qmk_toolbox_flash.jpg)
+
+この状態でキーボードをUSBで接続し、リセットボタンを押すとファームウェアの書き込みが始まります。\
+下記のように書き込みのメッセージが表示されれば完了です。
+
+![qmk_toolbox_flashed](assets/qmk_toolbox_flashed.jpg)
+
+片側のProMicroにファームウェアの書き込みが完了したら、もう片方も同じ手順で書き込みを行います。
+
+### (オプション) 自分でファームウェアをビルドする場合
+
+https://docs.qmk.fm/#/newbs_getting_started こちらを参照して頂き、ファームウェアを書き込む環境を用意します。
+
+環境ができましたら、下記コマンドで Crkbd 用にファームウェアをビルドします。
+
+```
+make crkbd/rev1/common:via
+```
+
+ビルドが完了したら下記コマンドを実行します。
+
+```
+make crkbd/rev1/common:via:avrdude
+```
+
+実行すると下記のようなログがでて、`.` が増えていくことが確認出来ると思います。
+この間にリセットスイッチを **2回** 押すとファームウェアの書き込みが完了します。
+なおProMicroによって1回の場合もあります。
+
+```
+<省略>
+
+Checking file size of crkbd_rev1_common_via.hex                                                        [OK]
+ * File size is fine - 27328/28672
+Copying crkbd_rev1_common_via.hex to qmk_firmware folder                                               [OK]
+Detecting USB port, reset your controller now........
+```
+
+片側のProMicroにファームウェアの書き込みが完了したら、もう片方も同じ手順で書き込みを行います。
+
+## キーマップの変更
+
+Corne Keyboard は [VIA](https://caniusevia.com/) に対応しています。\
+上記の手順で VIA 用のファームウェアを書き込むことで利用することできます。
+
+### VIA のダウンロード
+下記のURLから最新版の VIA をダウンロードします。\
+https://github.com/the-via/releases/releases/
+
+![via_download](assets/via_download.jpg)
+
+ダウンロードしたファイルから VIA をインストールします。\
+インストール方法は各OSの指示に従ってください。
+
+キーボードを接続した状態で VIA を開くと下記のようなウィンドウが表示されます。
+
+![via_begin](assets/via_begin.jpg)
+
+### KEYMAP / CONFIGURE
+
+この画面ではキーマップが変更できます。
+
+変更可能なキーはいくつかの種類に分類されていて、「１」のエリアから探すことができます。
+キーを変更する場合は「2」変更する場所をクリックし、「3」変更したいキーを選択します。
+なお VIA では瞬時にキーマップが書き換わります。
+
+![via_keymap_configure](assets/via_keymap_configure.jpg)
+
+### KEYMAP / TESTER
+
+この画面ではキーマップの動作テストができます。
+
+押したキーの色が変わることでキーが正しく設定されていることが確認できます。
+
+![via_keymap_tester](assets/via_keymap_tester.jpg)
+
+Test Matrix ではキーボードの各スイッチの動作確認ができます。
+実装後の動作確認はこちらで行ったほうがわかりやすいです。
+
+![via_keymap_tester_matrix](assets/via_keymap_tester_matrix.jpg)
+
+### LIGHTING
+
+この画面ではLEDのパターンや色の変更ができます。
+
+![via_lighitng](assets/via_lighting.jpg)