Mech Keys - aesser11/home-lab GitHub Wiki

QMK Setup

  • install qmk msys QMK MSYS
  • setup build env qmk setup
  • keymaps are stored in the keyboards/ directory

Useful QMK commands

Set qmk_firmware to a new home directory

qmk setup -H "C:/Users/USERNAME/Documents/GitHub/qmk_firmware"

Create a new keymap

qmk new-keymap -kb <keyboard_name>

Compile

qmk compile -kb <keyboard> -km <keymap>

default Ex:

qmk compile -kb <keyboard> -km default 

gmmk pro with user defined config named aesser11 Ex:

qmk compile -kb gmmk/pro -km aesser11

Flash

qmk flash -kb <keyboard> -km <keymap>

Putting keyboard into dfu/bootloader mode

  • my keymap uses fn + r
  • default gmmk pro keymap uses this method: Unplug your keyboard, hold down the Spacebar and B at the same time, plug in your keyboard and wait a second before releasing the keys

Alternative methods

  • Hold down both shift keys and press Pause
  • Hold down both shift keys and press B
  • Unplug your keyboard, hold down the top or bottom left key (usually Escape or Left Control) and plug in your keyboard
  • Press the physical RESET button, usually located on the underside of the PCB
  • Locate header pins on the PCB labeled RESET and GND, and short them together while plugging your PCB in

References

Docs

Repos

Gmmk Pro Specific

Drop ALT Specific

⚠️ **GitHub.com Fallback** ⚠️