ZMK

NOTE: Try to keep the repo up to date as much as possible. Pull from the upstream master and then rebase my branch on top of it.

Instructions for building

1. Install devcontainer cli

   brew install devcontainer
   

2. Setup the devcontainer

   devcontainer up --workspace-path . --docker-path $(which podman)
   

3. Initialize west (this takes a while)

   devcontainer exec --workspace-path . --docker-path $(which podman)
   west init -l app/
   west update
   

4. Build the firmware

   cd app
   west build --pristine -b nice_nano_v2 -- -DSHIELD=chrysemys
   

5. Copy the uf2 file onto the root of the USB mass storage for the keyboard. The uf2 file can be found at app/build/zephyr/zmk.uf2.

Documentation

• Docker setup
• Building