take&clock works QMK Install Memo

QMK Install

QMK Install Memo

A Windows-focused setup note for preparing QMK and building firmware for a DIY keyboard. This page covers preparing the QMK environment with QMK MSYS and confirming that the firmware can be built.

Links

Official Links

QMK official site qmk.fm/ QMK official documentation docs.qmk.fm/ QMK MSYS msys.qmk.fm/ QMK MSYS GitHub Releases github.com/qmk/qmk_distro_msys/releases

Setup

Setup Steps

01

Launch QMK MSYS

Launch QMK MSYS from the Start menu or its shortcut. Run the following commands inside the QMK MSYS terminal.

02

Clone qmk_firmware

Get the QMK firmware repository for this keyboard from GitHub.

git clone https://github.com/takehiko-cmd/qmk_firmware.git
03

Move into the folder

Move into the cloned qmk_firmware folder.

cd qmk_firmware
04

Run setup only the first time

Run QMK setup only the first time. If confirmation prompts appear, read them and continue.

qmk setup
05

Compile the firmware

Compile the default keymap for this keyboard.

qmk compile -kb takeclockworks/split_keyboard -km default
06

Check the UF2 file

Confirm that .build/takeclockworks_split_keyboard_default.uf2 has been generated.

07

Connect the XIAO RP2040 in BOOT mode

Hold the BOOT button while connecting it to the PC so it appears as the RPI-RP2 drive.

08

Copy the UF2 file

Copy the generated UF2 file to the RPI-RP2 drive.

09

Confirm flashing is complete

After the copy finishes, the drive closes automatically. That means the firmware has been written.

10

Test the keyboard

Check that the keys respond correctly in Notepad or QMK Console.

QMK and QMK MSYS are updated over time, so small details such as screen text or installer filenames may change. Check the official documentation and release pages if anything looks different.