Skip to content

Latest commit

 

History

History
74 lines (48 loc) · 2.48 KB

README.md

File metadata and controls

74 lines (48 loc) · 2.48 KB
Raw

QMK Keydo

A Colemak-DH based QMK firmware with ergo and programming in mind, designed for polyglots (compatible with Keydo).

Only one keymap is allowed for each keyboard profile.

  • Each folder represents a keyboard profile named in the form of <keyboard>.<version>, which matches with keyboard profiles in QMK Firmware
  • The <keymap> in this repo defaults to keydo unless specified

e.g. for a keyboard profile of preonic.rev3_drop, it has a <keyboard> of preonic and a <version> of rev3_drop

Documentation

Windows
Advanced users only. Expand this section if you want to hack QMK Keydo and compile your own keyboard profile

  • Download QMK MSYS

  • Set up QMK home in QMK MSYS (<qmk_home_path> defaults to ~/qmk_firmware/). It'll prompt you to clone the QMK Firmware repo

    qmk setup -H <qmk_home_path>

  • Pick a keyboard profile and move it to <qmk_home_path>/keyboards/<keyboard>/keymaps/

  • Rename the moved folder to keydo, which will become your <keymap>

  • Navigate to your QMK home in QMK MSYS

    cd <qmk_home_path>

  • Clean up the build environment

    make clean

  • Compile your keyboard profile (the compiled file will locate at <qmk_home_path>/.build/<keyboard>_<version>_<keymap>.{hex, bin})

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

  • Download QMK Toolbox

  • Install drivers menu > Tools > Install Drivers

  • Put your keyboard into DFU (Bootloader) mode (refer to QMK Flash Guide if needed)

  • Pick your keyboard's MCU (documented in each keyboard profile)

  • Pick your compiled keyboard profile (use QMK Keydo out of the box via the ready-to-go <keyboard>_<version>_<keymap>.{hex, bin} file in the build folder)

  • Flash your keyboard by clicking Flash

For more info, please refer to QMK Configs