Setup

1. Clone repo with submodules:

   git clone --recurse-submodules [repo_url]

For contributor workflow, build commands, and testing notes, see CONTRIBUTING.md.

You can also use the Makefile for common development tasks:

Makefile Usage

• Build all firmware (QMK and Vial, both halves):

  make all

• Build only QMK firmware:

  make qmk

• Build only Vial firmware:

  make vial

• Build left/right halves individually:

  make qmk-left
  make qmk-right
  make vial-left
  make vial-right

• Clean all build files:

  make clean

• Flash firmware (keyboard must be in bootloader mode):

  make flash         # QMK firmware
  make flash-vial    # Vial firmware

• List available keyboards:

  make list

• Run code linting:

  make lint

• Show all available targets and usage:

  make help

• First-time setup (initialize submodules, etc):

  make setup

• Prepare files for QMK PR submission:

  make prepare-pr

Tip:
You can override variables like KEYBOARD and KEYMAP on the command line:

make qmk KEYBOARD=onspry_tmp/zero/rev1 KEYMAP=default

See the Makefile for more advanced options and details.

qmk make git-submodule