History

Gergely Nagy 29f64d7a93 tap-dance: Major rework, to make it more reliable This reworks how the tap-dance feature works: instead of one global state, we have a state for each tap-dance key, so we can cancel them when another tap-dance key is in flight. This fixes #527. Since we have a state for each key, we can avoid situation where a keyup would mess with our global state. This fixes #563. And while here, we also make sure to fire events only once, and this fixes #574. There is one breaking change, though: tap-dance debugging support was removed, because dumping the whole state would increase the firmware size too much. Any keymap that made use of this, will have to be updated (but there's no such keymap in the repo). Also, there's a nice trick used in this rework: we need to iterate through tap_dance_actions in a few places, to check for timeouts, and so on. For this, we'd need to know the size of the array. We can't discover that at compile-time, because tap-dance gets compiled separately. We'd like to avoid having to terminate the list with a sentinel value, because that would require updates to all keymaps that use the feature. So, we keep track of the highest tap-dance code seen so far, and iterate until that index. Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>		2016-08-17 15:05:58 +02:00
..
ez	Move Ergodox readme from ez subfolder to parent	2016-07-29 21:09:37 +03:00
infinity	Small fix for infinity include guard	2016-07-29 21:09:42 +03:00
keymaps	tap-dance: Major rework, to make it more reliable	2016-08-17 15:05:58 +02:00
config.h	Move some of the Ergodox config settings to shared	2016-07-29 20:48:22 +03:00
ergodox.c	Most ergodox keymaps compiles on Infinity	2016-07-29 20:48:20 +03:00
ergodox.h	Most ergodox keymaps compiles on Infinity	2016-07-29 20:48:20 +03:00
Makefile	Initial structure for Ergodox as subprojects	2016-07-29 20:48:04 +03:00
readme.md	Updates ErgoDox readme	2016-08-01 21:15:01 -04:00

readme.md

Getting started

There are two main ways you could customize the ErgoDox (EZ and Infinity)

The Easy Way: Use an existing firmware file and just flash it (ErgoDox EZ only)

Download and install the Teensy Loader. Some Linux distributions already provide a binary (may be called teensy-loader-cli), so you may prefer to use this.
Find a firmware file you like. There are dozens of community-contributed keymaps you can browse and download. You can also use the Massdrop configurator to create a firmware Hex file you like.
Download the firmware file
Connect the keyboard, press its Reset button (gently insert a paperclip into the hole in the top-right corner) and flash it using the Teensy loader you installed on step 1 and the firmware you downloaded.

More technical: compile an existing keymap, or create your own totally custom firmware by editing the source files.

This requires a little bit of familiarity with coding. If you are just compiling an existing keymap and don't want to create your own, you can skip step 4, 5 and 8.

Go to https://github.com/jackhumbert/qmk_firmware and read the readme at the base of this repository, top to bottom. Then come back here :)
Clone the repository (download it)
Set up a build environment as per the readme.
Copy keyboards/ergodox/keymaps/default/keymap.c into keymaps/your_name/keymap.c (for example, keymaps/german/keymap.c)
Edit this file, changing keycodes to your liking (see "Finding the keycodes you need" below). Try to edit the comments as well, so the "text graphics" represent your layout correctly. See below for more tips on sharing your work.
Compile your firmware by running make keymap=keymap_name. For example, make keymap=german. This will result in a hex file, which will be called ergodox_ez_keymap_name.hex, e.g. ergodox_ez_german.hex. For Infinity ErgoDox you need to add subproject=infinity to the make command.
ErgoDox EZ - Flash this hex file using the Teensy loader as described in step 4 in the "Easy Way" above. If you prefer you can automatically flash the hex file after successful build by running make teensy keymap=keymap_name.

Infinity ErgoDox - Flash the firmware by running make dfu-util keymap=keymap_name subproject=infinity
Submit your work as a pull request to this repository, so others can also use it. :) See below on specifics.

Good luck! :)

Contributing your keymap

The QMK firmware is open-source, so it would be wonderful to have your contribution! Within a very short time after launching we already amassed dozens of 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. To make it easy for these people to use your layout, I recommend submitting your PR in the following format.

All work goes inside your keymap subdirectory (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.
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. :)
Any graphics you wish to add. This is absolutely not a must. If you feel like it, you can use Keyboard Layout Editor to make something and grab a screenshot, but it's really not a must. If you do have graphics, your readme can just embed the graphic as a link, just like I did with the default layout.

Finding the keycodes you need

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.