#+title: My Keymaps
#+link: qmk  https://qmk.fm

This is my repository of keyboard firmwares. I also have a repository of keyboard layouts defined in software.

* Ergodox EZ

This layout uses [[qmk]] firmware for its layout. To use it do the following:

- Install the qmk utility. (on Archlinux =sudo pacman -S qmk=)
- Once installed, run =qmk setup= to make sure the =~/qmk_firmware= directory is created.
- Set up the overlay directory so this keymap can be included: =qmk config user.overlay_dir=/PATH/TO/THIS/REPO=.
- Compile the keymap: =qmk compile -kb ergodox_ez -km ryuk=.
- Flash the keymap: =qmk flash -kb ergodox_ez -km ryuk=.

* Keyboardio Atreus

This layout uses [[qmk]] firmware for its layout. To use it do the following:

- Install the qmk utility. (on Archlinux =sudo pacman -S qmk=)
- Once installed, run =qmk setup= to make sure the =~/qmk_firmware= directory is created.
- Set up the overlay directory so this keymap can be included: =qmk config user.overlay_dir=/PATH/TO/THIS/REPO=.
- Compile the keymap: =qmk compile -kb keyboardio/atreus -km ryuk-atreus=.
- Flash the keymap: =qmk flash -kb keyboardio/atreus -km ryuk-atreus=.

* ZSA Voyager + Navigator

This layout uses a custom version of [[qmk]] firmware developed by ZSA for their devices. They say they'll contribute their changes to the QMK Firmware project, but until that time I need to use this fork instead. To use it do the following:

- Install the qmk utility. (on Archlinux =sudo pacman -S qmk=)
- Once installed, run =qmk setup= to make sure the =~/qmk_firmware= directory is created.
- Go into the =~/qmk_firmware= directory: =cd ~/qmk_firmware=.
- Add the ZSA repository as a remote: =git remote add zsa https://github.com/zsa/qmk_firmware.git=.
- Fetch the contents of the remote: =git fetch zsa=.
- Once complete, checkout the main branch: =git checkout zsafirmware25 zsa/firmware25=.
- Set up the overlay directory so this keymap can be included: =qmk config user.overlay_dir=/PATH/TO/THIS/REPO=.
- Compile the keymap: =qmk compile -kb zsa/voyager -km ryuk=.
- Flash the keymap: =qmk flash -kb zsa/voyager -km ryuk=.

* Cyboard Dactyl

This layout uses [[https://get.vial.today/][Vial]], which is built on top of [[qmk]], with added keyboards and some other changes. To use it:

- Install Vial (on Archlinux: =yay -S vial-appimage=).
- Run it (=Vial=).
- Plug in your keyboard.
- Any changes that are made in the layout using Vial are immediately stored on the keyboard.