keyboards/ergodox/keymaps/belak/README.md

   1 # Belak's Ergodox Layout
   2
   3 This has been based off of [emacs\_osx\_dk](https://github.com/jackhumbert/qmk_firmware/tree/master/keyboards/ergodox/keymaps/emacs_osx_dk)
   4 from the main qmk repo. However, I've taken some of the ideas for the thumbs
   5 from [dvorak\_emacs](https://github.com/jackhumbert/qmk_firmware/tree/master/keyboards/ergodox/keymaps/dvorak_emacs)
   6 and tweaked it a bit based on the keycaps I have.
   7
   8 This keyboard is intended for use in emacs (one of the main reasons for easy
   9 access to modifiers) but it could be useful in other instances as well.
  10
  11 The main repo is used as a testbed, so sometimes the layout may be in a strange
  12 state. The qmk version should be relatively stable.
  13
  14 ## Instructions
  15
  16 This is currently being used on a regular ergodox, but it should work fine on
  17 the infinity as well. Though, you may have to modify the commands to build and
  18 flash the firmware to match the separate halves as defined in the infinity
  19 documentation.
  20
  21 If you are using this keymap in the qmk repo, you should be able to just run
  22 `make ergodox-belak-teensy`. If you're using this externally (I sometimes make
  23 changes before syncing them to qmk), use the following instructions:
  24
  25 1. Clone the main qmk repo
  26 2. Clone this to `$QMK/keyboards/ergodox/keymaps/belak-external`
  27 3. Run `make ergodox-belak-external-teensy` from the root of the qmk repo.
  28
  29 ## Changelog
  30
  31 Fifth Revision
  32
  33 * Change layer keys to tap-dance keys which cycle through additional layers
  34 * Add a few emoji keys (in preparation for an emoji layer)
  35
  36 Fourth Revision
  37
  38 * Remove media layer
  39 * Add a layer which swaps control and gui on the thumb keys.
  40 * Add some basic code to save settings to the eeprom
  41 * Save the state of the keys swapped in the thumb in the eeprom
  42
  43 Third Revision
  44
  45 * Add numpad layer and remove numpad from symbols layer
  46 * Disable media layer
  47 * Add arrow keys on ijkl to the symbols layer
  48 * Replace ALT on held enter and held delete with GUI (for better OSX
  49   compatibility, as there's already an ALT key relatively close)
  50 * Replace keys above enter and delete with temporary layer switch buttons not
  51   matching the other layer switch for that hand.
  52 * Reindent and space out most of the layer definitions
  53
  54 Second Revision
  55
  56 * Clean up definitions to make differences between layers easier to see
  57 * Remove old LCD code
  58 * Add new LCD code based on fredizzimo's branch
  59
  60 First Revision
  61
  62 * Reverse grave and escape
  63
  64 Initial Version
  65
  66 * Copy from emacs\_osx\_dk
  67 * "Fix" right alt
  68 * Change thumb keys to match default layout (backspace, delete, enter, space)
  69 * Add modifiers to thumb keys (ctrl to backspace and space, alt to delete and
  70   enter)
  71 * Replace the RAlt below the brackets with LGui and RGui
  72 * Remove LCtrl and RCtrl from the keys above shift
  73 * Add browser forward, and move browser back
  74 * "Fix" the order of volume keys
  75
  76 ## Repository
  77
  78 The original code for this is kept at https://github.com/belak/ergodox-layout and
  79 is synced to qmk every few main revisions.