masq
/
qmk_firmware
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
qmk_firmware/keyboard/ergodox_ez
History
Gergely Nagy 1d1ced53c7 Update the ergodox-ez/algernon keymap (#409) 
Compared to the previous version, the following noteworthy changes have
been made to the keymap:

* The keyboard starts in NKRO mode, bootmagic and other things are
  disabled.
* A STENO layer was added, to be used with Plover.
* An experimental layout was added, something halfway between Dvorak and
  Capewell-Dvorak. A work in progress.
* `LEAD y` types \o/.
* Some keys on the BASE layer have been moved around:
  - `?` moved to the left pinky, left of `Q`.
  - `=` shifted one row down, but `F11` stayed where it was.
  - `-` on the left half was replaced by `Tab`.
  - `Tab`'s original position is taken by a `Media Next`/`Media Prev`
     key.
  - `:` now inputs `;` when shifted.
* `ESC` cancels the **HUN** layer too, not just modifiers.

Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>
 		2016-06-14 11:28:54 -04:00
..
keymaps Update the ergodox-ez/algernon keymap (#409) 2016-06-14 11:28:54 -04:00
util Adds Python script to util directory for easier discoverability 2016-06-06 21:47:57 -04:00
190hotfix.sh PR190hotfix.sh, fresh hexes, makeallhex.sh script 2016-03-11 11:16:19 -05:00
Makefile Makefile redo & other features (#395) 2016-06-11 13:31:31 -04:00
config.h Add custom config.h and revert the changes on the global one. 2016-05-10 16:17:30 -07:00
ergodox_ez.c Addressed void* return warning in all keymaps 2016-03-10 11:28:34 -05:00
ergodox_ez.h [Erez & Jack] Documents new Leader key functionality 2016-05-24 22:37:38 -04:00
i2cmaster.h [Jack & Erez] Comments + tiny updates and cleanup 2015-10-27 00:54:46 +02:00
matrix.c Squash the prototype compiler warning 2016-05-31 14:18:40 +01:00
readme.md Makefile redo & other features (#395) 2016-06-11 13:31:31 -04:00
twimaster.c [Jack & Erez] Comments + tiny updates and cleanup 2015-10-27 00:54:46 +02:00

readme.md

Getting started

There are two main ways you could customize the ErgoDox EZ.

The Easy Way: Use an existing firmware file and just flash it

  1. 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.
  2. Find a firmware file you like. You can find a few if these in the keymaps subdirectory right here. The file you need ends with .hex, and you can look at its .c counterpart (or its PNG image) to see what you'll be getting. You can also use the Massdrop configurator to create a firmware Hex file you like.
  3. Download the firmware file
  4. 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: create your own totally custom firmware by editing the source files.

This requires a little bit of familiarity with coding.

  1. 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 :)
  2. Clone the repository (download it)
  3. Set up a build environment as per the build guide
    • Using a Mac and have homebrew? just run brew tap osx-cross/avr && brew install avr-libc
  4. Copy keyboard/ergodox_ez/keymaps/default/keymap.c into keymaps/your_name/keymap.c (for example, keymaps/german/keymap.c)
  5. 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.
  6. Compile your firmware by running make keymap=your_name. For example, make keymap=german. This will result in a hex file, which will be called ergodox_ez_your_name.hex, e.g. ergodox_ez_german.hex.
  7. 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 successfull build by running make teensy keymap=your_name.
  8. 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 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.

  1. All work goes inside your keymap subdirectory (keymaps/german in this example).
  2. keymap.c - this is your actual keymap file; please update the ASCII comments in the file so they correspond with what you did.
  3. compiled.hex - a compiled version of your keymap. This allows people to just download your hex file and flash it without having to set up a build toolchain to make it.
  4. 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. :)
  5. 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.