From 22f12ceffb3c22c709b077b4edf4a4daa6430826 Mon Sep 17 00:00:00 2001 From: foostan Date: Tue, 3 Nov 2020 15:18:38 +0900 Subject: [PATCH] Update the firmware section of each keyboard --- corne-cherry/doc/v2/buildguide_jp.md | 35 ++---------- corne-cherry/doc/v3/buildguide_jp.md | 57 ++----------------- corne-chocolate/doc/buildguide_en.md | 43 ++------------ corne-chocolate/doc/buildguide_jp.md | 33 ++--------- corne-classic/doc/buildguide_en.md | 34 ++--------- corne-classic/doc/buildguide_jp.md | 33 ++--------- corne-light/doc/v1/buildguide_jp.md | 35 ++---------- .../doc/v2/buildguide_low_edition_jp.md | 55 ++---------------- 8 files changed, 35 insertions(+), 290 deletions(-) diff --git a/corne-cherry/doc/v2/buildguide_jp.md b/corne-cherry/doc/v2/buildguide_jp.md index 59480eb441..1ffab49026 100644 --- a/corne-cherry/doc/v2/buildguide_jp.md +++ b/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 こちらを参照して頂き、ファームウェアを書き込む環境を用意します。 - -環境ができましたら、下記コマンドで 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にファームウェアの書き込みが完了したら、もう片方も同じ手順で書き込みを行います。 - -以上で完成です。 +下記を参照しファームウェアをProMicroに書き込みます。\ +https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md ## LED（オプション） SK6812MINIを取り付けていきます。 diff --git a/corne-cherry/doc/v3/buildguide_jp.md b/corne-cherry/doc/v3/buildguide_jp.md index 1c59107bc6..289c1fb9ee 100644 --- a/corne-cherry/doc/v3/buildguide_jp.md +++ b/corne-cherry/doc/v3/buildguide_jp.md @@ -36,10 +36,8 @@ | WS2812B | 12個 | Undergrow 用 LEDs | ## 事前準備 -組み立ての途中で ProMicro にファームウェアを入れる作業がありますが、ファームウェアをビルドする環境を整備するのには時間がかかるためはじめに取り掛かっておくことをおすすめします。 - -https://docs.qmk.fm/#/ja/newbs_getting_started を参考にし、OSに合わせて必要なものをインストールしておきます。 -インストールに時間がかかるため動かしつつ組み立てを進めると効率的です。 +ファームウェアを自分でビルドする場合は環境を整備するのに時間がかかるのではじめに取り掛かっておくことをおすすめします。\ +詳しくは https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md を参照してください。 ## 確認 @@ -165,54 +163,9 @@ OLED用のピンソケットにピンヘッダを先に差し込み、その後 ![build_oled](assets/build_oled.jpg) -### ファームウェア -https://docs.qmk.fm/#/ja/newbs_getting_started こちら等を参考にし、OSに合わせて必要なものをインストールしておきます。 -上記の事前準備にも挙げたとおり、インストールに時間がかかるため事前に用意しておくことをおすすめします。 - -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に書き込みます。\ +https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md ### 動作確認 ProMicroとOLEDモジュールを付けた段階で動作確認をすることをおすすめします。 diff --git a/corne-chocolate/doc/buildguide_en.md b/corne-chocolate/doc/buildguide_en.md index 10fa2fc4cd..6cb3eab693 100644 --- a/corne-chocolate/doc/buildguide_en.md +++ b/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 - -It is recommended to [flash the firmware](#firmware) onto the Pro Micro before doing anything else, -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. +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. ## Building @@ -254,41 +252,8 @@ because it looks better. ![](https://user-images.githubusercontent.com/736191/52534914-00e19a80-2d8b-11e9-8005-7e0b157e09e4.png) ## Firmware - -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: 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. - -``` - - -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. +See below to flash the firmware to the ProMicro. \ +https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md This is the end. diff --git a/corne-chocolate/doc/buildguide_jp.md b/corne-chocolate/doc/buildguide_jp.md index 24e2a14f5b..3ea72f24e6 100644 --- a/corne-chocolate/doc/buildguide_jp.md +++ b/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 こちらを参照して頂き、ファームウェアを書き込む環境を用意します。 - -環境ができましたら、下記コマンドで 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にファームウェアの書き込みが完了したら、もう片方も同じ手順で書き込みを行います。 +下記を参照しファームウェアをProMicroに書き込みます。\ +https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md 以上で完成です。 diff --git a/corne-classic/doc/buildguide_en.md b/corne-classic/doc/buildguide_en.md index affe21ced2..576373703c 100644 --- a/corne-classic/doc/buildguide_en.md +++ b/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: -https://docs.qmk.fm/#/newbs_getting_started - -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. +See below to flash the firmware to the ProMicro. \ +https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md ### 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: diff --git a/corne-classic/doc/buildguide_jp.md b/corne-classic/doc/buildguide_jp.md index e9758a6b42..8821d2fb74 100644 --- a/corne-classic/doc/buildguide_jp.md +++ b/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 こちらを参照して頂き、ファームウェアを書き込む環境を用意します。 - -環境ができましたら、下記コマンドで 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にファームウェアの書き込みが完了したら、もう片方も同じ手順で書き込みを行います。 +下記を参照しファームウェアをProMicroに書き込みます。\ +https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md 以上で完成です。 diff --git a/corne-light/doc/v1/buildguide_jp.md b/corne-light/doc/v1/buildguide_jp.md index 2d949eaf5e..4bd297d3cd 100644 --- a/corne-light/doc/v1/buildguide_jp.md +++ b/corne-light/doc/v1/buildguide_jp.md @@ -110,8 +110,8 @@ ## 事前準備 -実装の途中で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に assembly-promicro-oled ### ファームウェアの書き込み -ProMicroとOLEDモジュールを付けた段階でファームウェアを書き込み、動作確認をすることをおすすめします(キースイッチを付けたあとに不具合が見つかると厄介です)。 - -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にファームウェアの書き込みが完了したら、もう片方も同じ手順で書き込みを行います。 +下記を参照しファームウェアをProMicroに書き込みます。\ +https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md ### 動作確認 diff --git a/corne-light/doc/v2/buildguide_low_edition_jp.md b/corne-light/doc/v2/buildguide_low_edition_jp.md index 737ac15cda..592fc96e72 100644 --- a/corne-light/doc/v2/buildguide_low_edition_jp.md +++ b/corne-light/doc/v2/buildguide_low_edition_jp.md @@ -33,10 +33,8 @@ | OLEDモジュール用ピンソケット 4連 2.5mm | 2つ | | ## 事前準備 -組み立ての途中で ProMicro にファームウェアを入れる作業がありますが、ファームウェアをビルドする環境を整備するのには時間がかかるためはじめに取り掛かっておくことをおすすめします。 - -https://docs.qmk.fm/#/ja/newbs_getting_started を参考にし、OSに合わせて必要なものをインストールしておきます。 -インストールに時間がかかるため動かしつつ組み立てを進めると効率的です。 +ファームウェアを自分でビルドする場合は環境を整備するのに時間がかかるのではじめに取り掛かっておくことをおすすめします。\ +詳しくは https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md を参照してください。 ## 確認 @@ -120,53 +118,8 @@ OLED用のピンソケットにピンヘッダを先に差し込み、その後 ![build_oled](assets/build_oled.jpg) ### ファームウェア -https://docs.qmk.fm/#/ja/newbs_getting_started こちら等を参考にし、OSに合わせて必要なものをインストールしておきます。 -上記の事前準備にも挙げたとおり、インストールに時間がかかるため事前に用意しておくことをおすすめします。 - -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に書き込みます。\ +https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md ### 動作確認 ProMicroとOLEDモジュールを付けた段階で動作確認をすることをおすすめします。