anafvana / planck-keymap

Flashing the Planck

1) Install qmk

For Mac, you will need Homebrew:

brew install qmk/qmk/qmk

For Linux distros, you will need Python/pip:

python3 -m pip install --user qmk

2) Set up qmk

setup qmk

3) Clone this repo

See 2 next points to clone directly into qmk home folder.

4) [OPTIONAL] Set home directory for QMK firmware

qmk setup -H /path/to/dir

Default is ~/qmk_firmware

5) Copy files into qmk home folder

Put files under keyboards/planck/keymaps/<keymap-name>

6) Compile keymap

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

This keymap is for the planck/ez/glow keyboard

7) Put keyboard in BOOT mode

For this keymap: LOWER + RAISE + esc

8) Flash the keyboard

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

This keymap is for the planck/ez/glow keyboard

More info

Known issues

If you are missing dependencies that cannot be automatically found with Homebrew, add the taps manually and retry:

brew tap osx-cross/avr osx-cross/arm
brew install avr-gcc arm-none-eabi-gcc@8

Make sure arm-none-eabi-gcc is added to your path.

Links

For all keycodes, see qmk/qmk_firmware/docs/keycodes

For full QMK tutorial, see docs.qmk.fm