/keymaps

Got sick of losing all my keymaps so here is a repo for me to find them.

Primary LanguageCGNU General Public License v2.0GPL-2.0

Keymaps ⌨️

GPL V2 licensed

Got sick of losing all my keymaps so here is a repo for me to find them.

Keyboard Firmware Switch
Planck Rev. 3 QMK Cherry MX Blue
Infinity Rev. 1 QMK Matias Quiet Click
Pok3r Stock Cherry MX Blue
Model M Soarers Buckling Springs
T-Rex QMK Kailh Pro L Green

Planck keyboard with DSA Deep Space keycaps

Getting Started

Clone the repository recursively to include the submodule:

git clone --recursive git@github.com:JordanMajd/keymaps.git

Alternatively, after a normal clone you can init the submodules with:

git clone git@github.com:JordanMajd/keymaps.git
git submodule update --init

QMK has some submodules of its own that need made

cd qmk_firmware
make git-submodule

Building and flashing

To build and flash a keyboard run the associated script and reset the keyboard:

# Planck reset = Raise + Lower + Q or button on back
./planck.sh

Define your own keyboard

To make a new keyboard you can use the following directory structure:

# make directories in this repo
mkdir keyboards/<keyboard>
mkdir keyboards/<keyboard>/<revision>
mkdir keyboards/<keyboard>/keymaps/<keymap>

Then create a script similar to the one found in planck.sh.

Happy hacking.

Thanos' Keyboard

Thanos wanted a keyboard too, so we built him one using a pro micro and Kailh Pro Light Green switches.

Use layout.hex or make your own firmware.

Create layout w/ Keyboard Layout Editor or just do text:

["T","R"],
["E","X"]

Build firmware w/ Keyboard Firmware set rows:

Rows: [B3, B1] Cols: [E6, D7]

Tap reset to ground twice then quickly flash w/ avrdude: C:\Users\<USERNAME>\AppData\Local\QMK\QMK Toolbox\0.0.14\avrdude.exe" -v -p atmega32u4 -PCOM5 -b57600 -c avr109 -D -U flash:w:"t_rex/layout.hex":i

Roadmap

  • Add Infinity layout.
  • Add Model M Soarers keymap.
  • Unlock Pok3r when JTAG programmer arrives.
  • Reset combo for Thanos' board.
  • Build script for Thanos' board.

Further Reading

License

This project is based on QMK which which in turn is based on TMK.

  • GPL V2, see LICENSE for more details.