History

Joel Challis abe4d9cdca Migrate build target markers to keyboard.json - E (#23529 )		2024-04-16 02:16:08 +01:00
..
keymaps/default
config.h
keyboard.json	Migrate build target markers to keyboard.json - E (#23529 )	2024-04-16 02:16:08 +01:00
post_rules.mk
readme.md
rules.mk
xmk_matrix.c	Clean up usage of `QMK_KEYBOARD_H` (#20167 )	2023-03-20 08:12:05 +11:00
xmk_matrix.h	Clean up usage of `QMK_KEYBOARD_H` (#20167 )	2023-03-20 08:12:05 +11:00
xmk_shell.c
xmk.c	Clean up usage of `QMK_KEYBOARD_H` (#20167 )	2023-03-20 08:12:05 +11:00

converter/xmk

converter/xmk is the QMK keyboard definition for 𝑥MK.

Make example for this keyboard (after setting up your build environment):

make converter/xmk:default

Flashing example for this keyboard:

make converter/xmk:default:flash

To flash pre-compiled firmware to a pro-micro on Linux without using the qmk CLI:

avrdude -p atmega32u4 -c avr109 -U flash:w:converter_xmk_default.hex:i -P /dev/ttyACM0

See the build environment setup and the make instructions for more information. Brand new to QMK? Start with our Complete Newbs Guide.

Bootloader

Enter the bootloader in 4 ways:

Boot shell command: Give the boot command to the converter/xmk shell, e.g. echo "boot" > /dev/ttyACM0
Keycode in layout: Press the key mapped to QK_BOOT if it is available
Physical reset button: Briefly press the button on the back of the PCB - some may have pads you must short instead
Bootmagic reset: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard