This is a thin layer on top of the qmk_firmware repo. QMK encourages modifying their repo with your own keymaps, which is pretty heavy and dumb. This repo lets you define your own keymaps separately from QMK's firmware, and the provided ./qmk script will take care of symlinking your custom keymaps into qmk_firmware so that they still build correctly.

Run ./qmk setup after cloning the repo. Answer Y (yes) to all the prompts.

It will clone a local copy of qmk_firmware into this repo.

You can update qmk_firmware at any time by cding to the directory and running git pull.

If you want to add a new keymap for a new keyboard:

1. Find the name of it, e.g. handwired/dactyl_manuform/5x7 (you can look in qmk_firmware/keyboards)
2. ./qmk clone handwired/dactyl_manuform/5x7 dactyl_5x7

You should now have a dactyl_5x7 directory.

After editing the keymap you cloned with ./qmk clone, compile your .hex file:

# replace "dactyl_5x7" with your map directory
$ ./qmk compile dactyl_5x7

To flash it onto your keyboard, plug it in and run:

$ ./qmk flash dactyl_5x7