keyboards/ergodox/readme.md

   1 # The Easy Way
   2
   3 If you can find firmware someone else has made that does what you want, that
   4 is the easiest way to customize your ErgoDox.  It requires no programming
   5 experience or the setup of a build environment.
   6
   7 Quickstart:
   8
   9   - Find and download an [existing firmware](#other-firmware-options)
  10
  11   - Then flash the firmware to your [ErgoDox Ez](#ergodox-ez)
  12     or [ErgoDox Infinity](#ergodox-infinity)
  13
  14 # Customizing Keymaps
  15
  16 There are many existing keymaps in the "keymaps" directory.  If you just want
  17 to use one of them, you don't need to modify keymaps and can just build and
  18 flash the firmware as described below.  These directories each have a
  19 "readme.md" file which describe them.
  20
  21 If none of the existing keymaps suit you, you can create your own custom
  22 keymap.  This will require some experience with coding.  Follow these steps
  23 to customize a keymap:
  24
  25   - Read the [qmk firmware README](https://github.com/jackhumbert/qmk_firmware) from top to bottom.  Then come back here.  :)
  26
  27   - Clone the qmk_firmware repository
  28
  29   - Set up your build environment (see below).
  30
  31   - Make a new directory under "keymaps" to hold your customizations.
  32
  33   - Copy an existing keymap that is close to what you want, such as
  34     "keymaps/default/keymap.c".
  35
  36   - Use an editor to modify the new "keymap.c".  See "Finding the keycodes you
  37     need" below).  Try to edit the comments as well, so the "text graphics"
  38     represent your layout correctly.
  39
  40   - Compile your new firmware (see below)
  41
  42   - Flash your firmware (see below)
  43
  44   - Test the changes.
  45
  46   - Submit your keymap as a pull request to the qmk_firmware repository so
  47     others can use it.  You will want to add a "readme.md" that describes the
  48     keymap.
  49
  50 # Build Dependencies
  51
  52 Before you can build, you will need the build dependencies.  There is a script
  53 to try to do this for Linux:
  54
  55   - Run the `util/install_dependencies.sh` script as root.
  56
  57 For the Infinity, you need the chibios submodules to be checked out or you
  58 will receive errors about the build process being unable to find the chibios
  59 files.  Check them out with:
  60
  61   - Go to the top level repo directory and run: `git submodule update --init --recursive`
  62
  63 # Flashing Firmware
  64
  65 ## ErgoDox Ez
  66
  67 The Ez uses the [Teensy Loader](https://www.pjrc.com/teensy/loader.html).
  68
  69 Linux users need to modify udev rules as described on the Teensy Linux page.
  70 Some distributions provide a binary, maybe called `teensy-loader-cli`).
  71
  72 To flash the firmware:
  73
  74   - Build the firmware with `make keymap=keymapname`, for example `make
  75     keymap=default`
  76
  77   - This will result in a hex file called `ergodox_ez_keymapname.hex`, e.g.
  78     `ergodox_ez_default.hex`
  79
  80   - Start the teensy loader.
  81
  82   - Load the .hex file into it.
  83
  84   - Press the Reset button by inserting a paperclip gently into the reset hole
  85     in the top right corder.
  86
  87   - Click the button in the Teensy app to download the firmware.
  88
  89 ## ErgoDox Infinity
  90
  91 The Infinity is two completely independent keyboards, and needs to be flashed
  92 for the left and right halves seperately.  To flash them:
  93
  94   - Build the firmware with `make keymap=keymapname subproject=infinity`
  95
  96   - Plug in the left hand keyboard only.
  97
  98   - Press the program button (back of keyboard, above thumb pad).
  99
 100   - Install the firmware with `sudo make dfu-util keymap=keymapname subproject=infinity`
 101
 102   - Build left hand firmware with `make keymap=keymapname subproject=infinity MASTER=right`
 103
 104   - Plug in the right hand keyboard only.
 105
 106   - Press the program button (back of keyboard, above thumb pad).
 107
 108   - Install the firmware with `sudo make dfu-util keymap=keymapname subproject=infinity MASTER=right`
 109
 110 More information on the Infinity firmware is available in the [TMK/chibios for
 111 Input Club Infinity Ergodox](https://github.com/fredizzimo/infinity_ergodox/blob/master/README.md)
 112
 113 ### Infinity Master/Two Halves
 114
 115 The Infinity is two completely independent keyboards, that can connect together.
 116 You have a few options in how you flash the firmware:
 117
 118 - Flash the left half, rebuild the firmware with "MASTER=right" and then flash
 119   the right half.  This allows you to plug in either half directly to the
 120   computer and is what the above instructions do.
 121
 122 - Flash the left half, then flash the same firmware on the right.  This only
 123   works when the left half is plugged directly to the computer and the keymap
 124   is mirrored.  It saves the small extra step of rebuilding with
 125   "MASTER=right".
 126
 127 - The same as the previous one but with "MASTER=right" when you build the
 128   firmware, then flash the same firmware to both halves.  You just have to
 129   directly connect the right half to the computer.
 130
 131 - For minor changes such as changing only the keymap without having updated
 132   any part of the firmware code itself, you can program only the MASTER half.
 133   It is safest to program both halves though.
 134
 135 # Contributing your keymap
 136
 137 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.
 138
 139 1. All work goes inside your keymap subdirectory (`keymaps/german` in this example).
 140 2. `keymap.c` - this is your actual keymap file; please update the ASCII comments in the file so they correspond with what you did.
 141 3. `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. :)
 142 4. Any graphics you wish to add. This is absolutely not a must. If you feel like it, you can use [Keyboard Layout Editor](http://keyboard-layout-editor.com) 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.
 143
 144 # Finding the keycodes you need
 145
 146 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`.
 147
 148 That file contains a big list of all of the special, fancy keys (like, being able to send % on its own and whatnot).
 149
 150 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.
 151
 152 # Other Firmware Options
 153
 154 There are external tools for customizing the layout, but those do not use
 155 the featurs of this qmk firmware.  These sites include:
 156
 157   - [Massdrop configurator](https://keyboard-configurator.massdrop.com/ext/ergodox) for Ez
 158   - [Input Club configurator](https://input.club/configurator-ergodox) for Infinity, provides left and right files
 159
 160 You can also find an existing firmware that you like, for example from:
 161
 162   - [Dozens of community-contributed keymaps](http://qmk.fm/keyboards/ergodox/)
 163
 164 This qmk firmware also provides the ability to customize keymaps, but requires
 165 a toolchain to build the firmware.  See below for instructions on building
 166 firmware and customizing keymaps.