Table of Contents
This is my repository of keyboard firmwares. I also have a repository of keyboard layouts defined in software.
1. Ergodox EZ
This layout uses https://qmk.fm firmware for its layout. To use it do the following:
- Install the qmk utility. (on Archlinux
sudo pacman -S qmk) - Once installed, run
qmk setupto make sure the~/qmk_firmwaredirectory 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.
2. Keyboardio Atreus
This layout uses https://qmk.fm firmware for its layout. To use it do the following:
- Install the qmk utility. (on Archlinux
sudo pacman -S qmk) - Once installed, run
qmk setupto make sure the~/qmk_firmwaredirectory 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.
3. ZSA Voyager + Navigator
This layout uses a custom version of https://qmk.fm 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 setupto make sure the~/qmk_firmwaredirectory is created. - Go into the
~/qmk_firmwaredirectory: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.
4. Cyboard Dactyl
This layout uses Vial, which is built on top of https://qmk.fm, 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.
