diff options
| author | Erez Zukerman <ezuk@madmimi.com> | 2015-10-28 02:55:28 +0200 |
|---|---|---|
| committer | Erez Zukerman <ezuk@madmimi.com> | 2015-10-28 02:55:28 +0200 |
| commit | 2739aa8d780a8210eac30a284786d60dedc671bc (patch) | |
| tree | 9b7822b5175fbbdd53190fc1fb0eb4516fd4a092 /keyboard/ergodox_ez/README.md | |
| parent | 18da1e6801335b0d9515ab72e9236a01d629915f (diff) | |
Initial working version of ErgoDox EZ layout using new syntax
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. |