<aside> 🔧 This is the build guide for the Sofle Choc Kit from https://choc.brianlow.com/

</aside>

<aside> 💡 Apr 2022: The firmware described here is still under active development. Check back if you pull the latest branch. You can also follow the PR.

</aside>

Quick Start

1. Install QMK Toolbox

2. Download the firmware (right click link → Save As….)

   sofle_choc_via_8ecd70dc.hex

3. Open QMK Toolbox, choose the .hex file you downloaded

4. Press the reset button on the PCB twice OR short RST and GND pins twice. The two presses have to be within one second or so. The RST and GND pins are on the right side, 2nd and 3rd from the top (USB connector).

5. QMK Toolbox should show a yellow log message: “Caterina device connected...”

6. Click Flash

7. Optionally, download and open the Via app. It will detect the keyboard when it is plugged in and you can remap keys on the fly.

8. Continue to Powering Up

<aside> 💡 You can flash the ProMicro before or after it is installed on the PCB. Flashing when not installed is a good way to narrow down problems

</aside>

<aside> 💡 You can flash with or without the two halves connected together. Remember to connect/disconnect the TRS/TRRS cable only when not powered to avoid shorts.

</aside>

Compiling and Flashing with Docker

Using Docker is easy to setup and reliable across operating systems (especially Windows):

1. Install Docker

2. Install QMK Toolbox

3. Compile the firmware

   git clone [email protected]:brianlow/qmk_firmware.git
   cd qmk_firmware
   git checkout choc2   # latest version of QMK+firmware, but has minimumal keymap
   git checkout choc3   # older version will full Sofle keymap
   ./util/docker_build.sh sofle_choc:via