This project is designed for the Ergodox EZ which uses the qmk firmware.
My never ending quest to have the perfect keyboard layout. This project is very closely related with my dotfiles repo. In fact, I would go as far as to say that if you don't have the background of the dotfiles, many of the macros will seem very random.
In this repository, the every release is a keymap location change. Major releases indicate that there is an intrusive change that will require a workflow shift. Minor changes indicate a key moved here or there, and doesn't really warrant for a full fledged release.
- Clone the qmk_firmware repo.
- Make a folder in
keyboards/ergodox_ez/keymaps/ - Move source files to the new folder
- Go back to the
qmk_firmwareroot - Run
make ergodox_ez:<folder name> - Using the
.hexfile, follow these directions to flash your Ergodox
This assumes that you have Docker installed.
Just run docker-compose up and the .hex file will automagically be made for you! Any time you
edit the keymap.c file, just rerun docker-compose up to recompile it.
If there are any new updates to the qmk_firmware repo, just run a docker-compose build.
Only if you edit the Dockerfile, then you need to run a docker-compose build... but if you're
editing the Dockerfile, then you already know that.
Note: If you are on Linux, you can also run ./run.sh which will do all of
the above steps for you. Disregard all of the Jenkins stuff... that's just for
CI
If it is your first time running it, Docker will be creating the environment in order to compile the keymap. After your first time, every recompile should take a couple of seconds.
This image is literally only used once, so it isn't very beneficial to publish it. Also, qmk is a
live repository, and it is easier to do a docker-compose build, which will run relatively fast
because of how docker caches, than it is to publish a new image for every release of qmk.
Please checkout the comments in keymap.c to see what the current layout of the keyboard is. To
see the different revisions of the layout, please see the releases section.
TODO
TODO