Erez Zukerman 0457ed4880 | 8 years ago | |
---|---|---|
.. | ||
keymaps | 8 years ago | |
190hotfix.sh | 8 years ago | |
Makefile | 8 years ago | |
config.h | 8 years ago | |
ergodox_ez.c | 8 years ago | |
ergodox_ez.h | 8 years ago | |
i2cmaster.h | 8 years ago | |
makeallhex.sh | 8 years ago | |
matrix.c | 8 years ago | |
readme.md | 8 years ago | |
twimaster.c | 8 years ago |
There are two main ways you could customize the ErgoDox EZ.
teensy-loader-cli
), so you may prefer to use this.This requires a little bit of familiarity with coding.
brew tap osx-cross/avr && brew install avr-libc
keyboard/ergodox_ez/keymaps/default/keymap.c
into keymaps/your_name/keymap.c
(for example, keymaps/german/keymap.c
)make clean
followed by make KEYMAP=your_name
. For example, make KEYMAP=german
. This will result in a hex file, which will always be called ergodox_ez.hex
, regardless of your keymap name.make teensy KEYMAP=your_name
.Good luck! :)
The ErgoDox EZ firmware is open-source, so it would be wonderful to have your contribution! Within a very short time after launching we already amassed almost 20 user-contributed keymaps, with all sorts of creative improvements and tweaks. This is very valuable for people who aren't comfortable coding, but do want to customize their ErgoDox EZ. To make it easy for these people to use your layout, I recommend submitting your PR in the following format.
keymaps/german
in this example).keymap.c
- this is your actual keymap file; please update the ASCII comments in the file so they correspond with what you did.german.hex
- a compiled version of your keymap. Commit it to the repo with git add -f
as hex files are ignored by default. This allows people to just download your hex file and flash it without having to set up a build toolchain to make it.readme.md
- a Readme file, which GitHub would display by default when people go to your directory. Explain what's different about your keymap, what you tweaked or how it works. No specific format to follow, just communicate what you did. :)Let's say you want a certain key in your layout to send a colon; to figure out what keycode to use to make it do that, you're going to need quantum/keymap_common.h
.
That file contains a big list of all of the special, fancy keys (like, being able to send % on its own and whatnot).
If you want to send a plain vanilla key, you can look up its code under doc/keycode.txt
. That's where all the boring keys hang out.