Build QMK Firmware / Vial using Dev Container

Quick Start

このリポジトリを clone する

$ git clone https://github.com/tamago324/keyboard-firmwares

clone したら、VSCode で開き、 (Dev Containers 拡張機能を入れておく)
Dev Container で開く (コンテナで再度開くのメッセージが表示されたら、クリックして開ける)

初回のセットアップが行われ、__qmk__ と __vial__ が作成されたらセットアップ完了

ビルドするには

$ fwbuild qmk <keyboard>:<keymap> [-v <version>]
$ fwbuild vial <keyboard>

のように実行する

次回以降は Dev Container で開くことですぐに fwbuild コマンドでビルド可能
また、環境を作り直したい場合、__qmk__/ と __vial__/ を削除し、開発コンテナー: コンテナでリビルドして再度開く コマンドを実行する

Create keyboard firmware

keyboards/ ディレクトリ配下に QMK Firmware の keyboards と同じように作成する

fwbuild qmk generate-compilation-database <kb>:<km> で VSCode で開発しやすいようにする

Usage

fwbuild

fwbuild <command> [options]

Commands:
  fwbuild qmk     Build QMK firmware with specified options
  fwbuild vial    Build Vial firmware with specified options

Options:
  fwbuild <command> --help  Show <command> help message

fwbuild qmk

fwbuild qmk <options>

Commands:
  fwbuild qmk compile <keyboard>:<keymap> [-v <version>]
  fwbuild qmk generate-compilation-database <keyboard>:<keymap> [-v <version>]
  fwbuild qmk --versions
  fwbuild qmk --help

Options:
  -v <version>   Specify the QMK firmware version. If not specified, the latest tag will be used.
  --versions     List available QMK firmware versions
  --help         Show this help message and exit

fwbuild vial

fwbuild vial <options>

Commands:
  fwbuild vial <keyboard>

Options:
  --generate-uid  Show this help message and exit
  --help  Show this help message and exit

Special Thanks

• GPK FWMaker
• Keyball GitHub Actions