QMK Firmwareのビルド環境をQMK MSYSを用いて構築する手順です。
まずはQMK MSYSのリリースページからインストーラのダウンロードを行います。
- Windows用インストーラ
QMK_MSYS.exe
ダウンロードしたインストーラを実行してQMK MSYSのインストールを行います。
スタートメニューからQMK MSYSを選択して起動します。
本家のQMK Firmwareを利用する場合は以下のコマンドを実行します。
qmk setup
標準ではC:\Users\USER_NAME\qmk_firmwareにコピー(git clone)されます。保存場所を指定したい場合は以下のようにします。
qmk setup --home C:/<path>/qmk_firmware
qmk setupが進むと、保存場所を確認されますので、問題なければy[Enter]と入力します。
*** Would you like to clone qmk/qmk_firmware to C:/<path>/qmk_firmware? [y/n]
次のプロンプトでは、保存したQMK FirmwareのパスをQMK Homeに設定するか尋ねられますので、y[Enter]と入力します。
*** Would you like to set C:/<path>/qmk_firmware as your QMK home? [y/n]
y[Enter]とした場合、環境変数[QMK_HOME]にQMK Firmwareのパスが保存され、qmk compileやqmk flashといったコマンドでこのパス内が参照されます。逆にn[Enter]とすると、qmk compileやqmk flashといったコマンドが効かなくなるので、余程のことがない限りy[Enter]としてください。
必要なツールが足りない場合はインストールするか確認するプロンプトが出ますので、問題なければy[Enter]と入力します。
*** Would you like to install dependencies? [y/n]
forkされたQMK Firmwareを利用する場合は以下のようにします。
qmk setup <github_username>/qmk_firmware --branch <branch_name>
標準ではC:\Users\<USER_NAME>\qmk_firmwareにコピー(git clone)されます。保存場所を指定したい場合は以下のようにします。
qmk setup <github_username>/qmk_firmware --branch <branch_name> --home C:/<path>/qmk_firmware
qmk setupが進むと、保存場所を確認されますので、問題なければy[Enter]と入力します。
*** Would you like to clone qmk/qmk_firmware to C:/<path>/qmk_firmware? [y/n]
次のプロンプトでは、保存したQMK FirmwareのパスをQMK Homeに設定するか尋ねられますので、y[Enter]と入力します。
*** Would you like to set C:/<path>/qmk_firmware as your QMK home? [y/n]
既に本家のQMKがインストールされている場合でも、y[Enter]と入力して構いません。本家への切り替え手順は次の項で説明します。
必要なツールが足りない場合はインストールするか確認するプロンプトが出ますので、問題なければy[Enter]と入力します。
*** Would you like to install dependencies? [y/n]
以下のコマンドで、現在どのQMKがQMK Homeに指定されているか確認できます。
qmk config -ro
切り替えは以下のように切り替え先のQMKのパスを記載します。
qmk setup --home c:/<path>/qmk_firmware
指定したパスにQMKが存在する場合は以下のような確認プロンプトが出ます。
INFO Found qmk_firmware at c:/<path>/qmk_firmware.
*** Would you like to set c:/<path>/qmk_firmware as your QMK home? [y/n]
y[Enter]と入力することで、切り替えができます。
以下のコマンドを実行します。
qmk flash -kb <keyboard_name> -km <keymap_name>
この文書に掲載されている情報は、文書を書いている時点の情報ですので、将来変更される場合があります。
セットアップに関しては公式情報を確認することをお勧めします。
QMKのコマンドについては、ヘルプを確認することをお勧めします。
qmk --help
qmk setup --help
qmk flash --help