keyboards/ergodox/readme.md

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