QMK Logo QMK Firmware

The goal of the QMK software project is to develop a completely customizable, powerful, and enjoyable firmware experience for any project - keyboard or otherwise - and to provide helpful, encouraging, and kind support and feedback for people with any software development experience.

View on GitHub

Download Zip Download Tar

Current Version Build Status Discord Docs Status GitHub contributors GitHub forks

Pages

How to support QMK

This project is maintained by QMK collaborators and contributors like you!

Hosted on GitHub Pages — Theme by orderedlist

The QMK Trademark

“QMK Firmware” and the logo are a trademark registered by Jack Humbert to help encourage keyboard makers to contribute back to the community and to help the community offer support for the keyboards running QMK.

Anyone is entitled and encouraged to use the logo, the term “QMK (Firmware)”, “Powered by QMK (Firmware)” (or similar wording with “running”, “compatible with”, etc) provided they:

  1. Don’t imply QMK or its contributors endorse/make the keyboard
  2. Contribute their keyboard’s configuration back to qmk:master roughly by the keyboard’s ship date
  3. Link to the QMK website or Github repo on their product page

Images with the logo and preferred wording to use on PCBs, print-outs, websites, stickers, merch, etc are below.

Optional steps

  1. Request a tag (<keyboard>-<version> e.g. planck-4.2) of the commit shipped with the keyboard in qmk/qmk_firmware. A compiled .hex/.bin is usually added to the release page for this.
  2. Be aware of GPL compliance - having a tag in the repo helps with this.

If your project uses QMK as the default and official firmware, we’d like to add it to the list on the homepage, so let us know by creating an pull request on qmk/qmk.fm if it’s not there!

Images

These are the default-sized badges in svg format (pngs: dark, light):

QMK Badge Dark QMK Badge Light

A smaller version of each (pngs: dark, light):

QMK Badge Small Dark QMK Badge Small Light

And badges for compatible or community-supported keyboards (pngs: dark, light):

QMK Community Badge Dark QMK Community Badge Light

Please do not use modified versions these images - if you’d like to use something different, let us know, and we’ll do our best to accommodate your wishes!

This page’s modification history can be viewed here.