peromage / qmk-layouts

My QMK firmware compatible keyboard layouts

Peromage’s QMK Keyboard Layouts

This repo contains my customized layouts for QMK/ZSA forked QMK compatible keyboards.

Previews

planck_ez_glow_prmg01-comfy

Quick start

Setup environment

The QMK official doc is a good start point.

To make it simpler, install QMK tools first through pip.

pip install --user qmk

Then initialize the firmware repo. Located at $HOME/qmk_firmware by default.

# If using ZSA keyboards with their firmware
# e.g. Planck EZ
qmk setup zsa/qmk_firmware -b firmware22

# If using standard QMK firmware
qmk setup

Apply patches (optional)

git apply patches/planck_ez_glow_reduced-power-consumption.patch

Build firmware

Here the planck_ez_glow_prmg01-comfy is used as the example.

# Copy the layout source code
cp -r planck_ez_glow_prmg01-comfy/planck_ez_glow_prmg01-comfy_source $HOME/qmk_firmware/keyboards/planck/ez/glow/keymaps/prmg01-comfy

# Compile
qmk compile -kb planck/ez/glow -km prmg01-comfy

The firmware binary can be found at the root of the firmware repo, e.g. $HOME/qmk_firmware/planck_ez_glow_prmg01-comfy.bin.

Flash firmware

For ZSA keyboards, use Wally (Linux/Windows/MacOS).

For general QMK compatible keyboards, use QMK Toolbox (Windows/MacOS).

The more generic way is to flash through CLI (Linux/Windows/MacOS).

qmk flash -kb planck/ez/glow -km prmg01-comfy

If the bootloader is not automatically detected, check out the QMK doc.