https://github.com/tombruijn/ergodox-ez-keymap

My ErgoDox EZ keymap
https://github.com/tombruijn/ergodox-ez-keymap

Last synced: 13 days ago
JSON representation

My ErgoDox EZ keymap

• Host: GitHub
• URL: https://github.com/tombruijn/ergodox-ez-keymap
• Owner: tombruijn
• Created: 2016-05-22T12:14:16.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2020-09-19T09:07:04.000Z (over 4 years ago)
• Last Synced: 2024-12-12T23:07:55.149Z (19 days ago)
• Language: C
• Homepage:
• Size: 42 KB
• Stars: 0
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# ErgoDox EZ Keymap

[Tom de Bruijn]'s [ErgoDox EZ] keymap.

This is a keymap used by the [qmk_firmware] using revision

`d8253b83e81086514a72fe0dfde7e75c047cccc2`.

This works on the ErgoDox EZ Shine and an ErgoDox EZ from 2016.

The keymap contains multiple layers. There are ASCII "images" of each layer in

the [keymap.c](keymap.c) file.

- Layer 0 - Base layer

  - ErgoDox QWERTY keyboard

  - Modifier keys are different

- Layer 1 - Symbol layer

  - [Norman-style layout] symbol layer for ErgoDox

- Layer 2 - Media layer

  - Media controls

  - Arrow keys

- Layer 3 - App and window management layer

  - Same as layer 0, but every key is their HYPER version. Used by my

    [Hammerspoon config].

- Layer 4 - RGB light configuration layer

  - Only works on the ErgoDox EZ Shine

- Layer 5 - Mouse controls layer

## Usage

The keymap in this repository is to be used in combination with the [qmk_firmware] repository.

Modify the [keymap.c](keymap.c) file to change the keyboard layout and layers.

## Installing keymap

1. Clone the [qmk_firmware] repository.

2. Follow the installation instruction on the [qmk_firmware] repository.

3. Clone this repository in the following directory inside the qmk_firmware repository:

    - `keyboards/ergodox_ez/keymaps/tombruijn/`

4. Start teensy and set teensy to automatic.

5. Modify keymap, if necessary.

6. Run the following command inside the qmk_firmware root directory.

    - `make ergodox_ez:tombruijn`

7. Point teensy to use the generated hex file. (Only have to do this once per teensy start.)

8. Press the teensy button on the keyboard with a paperclip.

9. The ErgoDox EZ will restart with the new keymap.

Repeat steps 5-9 until happy :)

[Tom de Bruijn]: https://github.com/tombruijn

[Hammerspoon config]: https://github.com/tombruijn/dotfiles/tree/master/hammerspoon

[ErgoDox EZ]: https://ergodox-ez.com/

[Norman-style layout]: https://www.normanlayout.info/

[qmk_firmware]: https://github.com/jackhumbert/qmk_firmware