/zmk

ZMK Firmware Repository

Primary LanguageCMIT LicenseMIT

Zephyr™ Mechanical Keyboard (ZMK) Firmware

Discord Build Contributor Covenant

ZMK Firmware is an open source (MIT) keyboard firmware built on the Zephyr™ Project Real Time Operating System (RTOS). ZMK's goal is to provide a modern, wireless, and powerful firmware free of licensing issues.

Check out the website to learn more: https://zmk.dev/

You can also come join our ZMK Discord Server

To review features, check out the feature overview. ZMK is under active development, and new features are listed with the enhancement label in GitHub. Please feel free to add 👍 to the issue description of any requests to upvote the feature.

How-To

This repo adds the maple board under app/boards/shields/maple along with a ./build.sh script to easily build the keymap. Double tap the connect keyboards reset button and drag the respective .uf2 file to the keyboard (in Finder).

  • Make sure Docker is running
  • Open this folder in VS Code
  • Click the popup notification to Reopen in Container
  • You can now run the ./build.sh script from the Terminal in VS Code