This repo holds the QMK-related files that I use to flash my keyboard. This guide mainly serves as a reminder to myself on how to flash my keyboard, and how to set up the firmware, but if you stumble upon this and find it useful, then I'm glad to have helped. Feel free to use my keymap. (If you do, please let me know! I'd love to hear about it.)
I currently use a Sofle Choc. I put in a custom print order for the PCB at jlcpcb, and sourced the parts from SplitKB.
There are two components in this directory:
codevogelis a directory that holds the QMK firmware for my keyboard. Explanation for the containing files can be found at QMK's reposofle_choc_codevogel_qmk_keymap.jsonholds the keybinds in JSON format. This is handy for when you want to use the QMK Configurator to edit the keymap. (We can then runqmk json2cto convert the exported JSON to a C file, and nab the keymap array from there to re-use incodevogel/keymap.c.)
-
Clone (optionally a personal fork of) the QMK firmware repository:
git clone git@github.com:qmk/qmk_firmware.git
-
Copy the
codevogeldirectory atsofle_choc/codevogeltoqmk_firmware/keyboards/sofle_choc/keymaps/ -
Follow the instructions in the QMK documentation to set up your environment.
-
(Optional:) Compile the firmware with the following command:
qmk compile -kb sofle_choc -km codevogel
-
Unplug the Keeb. Remove the TRSS cable from both sides. Plug the USB cable back into one half of the Keeb.
-
Compile and flash the firmware to your Keeb. When asked, short the reset pins to enter bootloader mode. (If things don't work, read step 7 to make sure you are using the right flasher)
qmk flash -kb sofle_choc -km codevogel
-
Update the
BOOTLOADDERvariable inqmk_firmware/keyboards/sofle_choc/keymaps/codevogel/rules.mk. The Elite-C (USB-C) controller needs the atmel-dfu bootloader, while the Pro Micro (USB-Mini) controller needs the caterina bootloader. -
Repeat for the other half of the Keeb.
-
Enjoy your new keymap!