diff options
Diffstat (limited to 'keyboard/ergodox_ez/README.md')
| -rw-r--r-- | keyboard/ergodox_ez/README.md | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/keyboard/ergodox_ez/README.md b/keyboard/ergodox_ez/README.md index f750d8dbec..5280698a62 100644 --- a/keyboard/ergodox_ez/README.md +++ b/keyboard/ergodox_ez/README.md @@ -1 +1,9 @@ -// TODO: Make up a proper readme for the ErgoDox EZ. +# Some tips on navigating the Quantum codebase + +## These are the keycodes you're looking for + +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 shend % 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. |