QMK Logo QMK Firmware

An open source firmware for AVR and ARM based keyboards

View on GitHub

Download Zip Download Tar

Current Version Build Status Gitter 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

Keyboards Powered by QMK

If you’d like to advertise QMK compatibility or use QMK as the default/official firmware for your keyboard, we ask that you do the following to help the community provide support for your keyboard through our help channels (r/mk, r/olkb, Gitter, QMK GitHub, etc).

  1. Submit a pull request (and have it merged) with support for your keyboard as advertised (with accurate info) to qmk/qmk_firmware
  2. If your keyboard has an integrated chip, ship your keyboard with QMK pre-flashed on it (this is optional for Teensy/Pro Micro kits)
    • Request a tag (<keyboard>-<version> e.g. planck-4.2) of the commit shipped with the keyboard in qmk/qmk_firmware by contacting a collaborator via the Gitter. A compiled .hex/.bin is usually added to the release page for this.
  3. Link to http://qmk.fm or https://github.com/qmk/qmk_firmware from your product page, optionally using a badge below.
  4. Be aware of GPL compliance - having a tag in the repo helps with this.

If you need help with this, please open an issue or hop on Gitter, and we’d be happy to help! A schematic of your keyboard, and as much information you can provide would be helpful

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!

Badges

If you’ve followed the steps above, you can use these badges! 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.