The built program can be found in github actions under the corresponding commit. There will be a file called "fireware.zip" that can be downloaded and flashed to the keyboard.
- Connect the keyboard via a USB cable.
- Double click the reset button on the keyboard (found below the rotary encoder) to enter bootloader mode. The keyboard should show up as a mass storage device on your computer.
- Copy the "firmware.uf2" file from the downloaded release to the mass storage device to flash the keyboard. The storage device should automatically eject and the keyboard will reboot with the new firmware.
Source code is built in github actions using the ZMK firmware framework. To build the firmware locally, follow these steps:
- Clone the ZMK repository using the following command:
git clone https://github.com/zmkfirmware/zmk.git
- Set up the Zephyr SDK as described here
- From the zmk directory, run the following commands to build the firwmare, ensuring to replace "/path/to/this/repo/config" with the path to the config directory in this repository:
cd app
west build -p -b nice_nano_v2 -- -DSHIELD=tp_marking_keyboard -DZMK_CONFIG=/path/to/this/repo/config
The built firmware file can be found at "/path/to/zmk/app/build/zephyr/zmk.uf2", and can be flashed with the flash instructions above, treating "zmk.uf2" as "firmware.uf2". For more information, see the ZMK documentation and Zephyr documentation