2017-06-10 18:58:24 +00:00
# Quantum Mechanical Keyboard Firmware
2018-05-08 04:58:50 +00:00
[](https://github.com/qmk/qmk_firmware/tags)
[](https://travis-ci.org/qmk/qmk_firmware)
[](https://discord.gg/Uq7gcHh)
[](https://docs.qmk.fm)
[](https://github.com/qmk/qmk_firmware/pulse/monthly)
[](https://github.com/qmk/qmk_firmware/)
## What is QMK Firmware?
2017-06-10 18:58:24 +00:00
2020-02-20 23:50:50 +00:00
QMK (*Quantum Mechanical Keyboard*) is an open source community centered around developing computer input devices. The community encompasses all sorts of input devices, such as keyboards, mice, and MIDI devices. A core group of collaborators maintains [QMK Firmware ](https://github.com/qmk/qmk_firmware ), [QMK Configurator ](https://config.qmk.fm ), [QMK Toolbox ](https://github.com/qmk/qmk_toolbox ), [qmk.fm ](https://qmk.fm ), and this documentation with the help of community members like you.
2017-06-10 18:58:24 +00:00
2020-02-20 21:09:37 +00:00
## Get Started
2017-06-10 18:58:24 +00:00
2020-02-20 21:09:37 +00:00
Totally new to QMK? There are two ways to get started:
2017-06-10 18:58:24 +00:00
2020-02-20 21:09:37 +00:00
* Basic: [QMK Configurator ](https://config.qmk.fm )
* Just select your keyboard from the dropdown and program your keyboard.
* We have an [introductory video ](https://www.youtube.com/watch?v=-imgglzDMdY ) you can watch.
2020-02-20 23:50:50 +00:00
* There is also an overview [document you can read ](newbs_building_firmware_configurator.md ).
2020-02-20 21:09:37 +00:00
* Advanced: [Use The Source ](newbs.md )
* More powerful, but harder to use
2017-06-10 18:58:24 +00:00
2020-02-20 21:09:37 +00:00
## Make It Yours
2017-06-10 18:58:24 +00:00
2020-02-20 21:09:37 +00:00
QMK has lots of [features ](features.md ) to explore, and a good deal of reference documentation to dig through. Most features are taken advantage of by modifying your [keymap ](keymap.md ), and changing the [keycodes ](keycodes.md ).
2020-02-20 23:50:50 +00:00
## Need help?
2020-03-01 16:57:26 +00:00
Check out the [support page ](support.md ) to see how you can get help using QMK.
2020-02-20 23:50:50 +00:00
## Give Back
There are a lot of ways you can contribute to the QMK Community. The easiest way to get started is to use it and spread the word to your friends.
* Help people out on our forums and chat rooms:
* [/r/olkb ](https://www.reddit.com/r/olkb/ )
* [Discord Server ](https://discord.gg/Uq7gcHh )
* Contribute to our documentation by clicking "Edit This Page" at the bottom
* [Translate our documentation into your language ](translating.md )
2020-03-01 05:17:17 +00:00
* [Report a bug ](https://github.com/qmk/qmk_firmware/issues/new/choose )
* [Open a Pull Request ](contributing.md )
