~ruther/qmk_firmware

ref: 7b31c18d464356bde219c5b3fff346f3e7a89d1a qmk_firmware/docs/README.md -rw-r--r-- 1.7 KiB
7b31c18d — Peter Fix English word list retrieval in qmk generate-autocorrect-data (#20915) 2 years ago

#Quantum Mechanical Keyboard Firmware

#What is QMK Firmware?

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, QMK Configurator, QMK Toolbox, qmk.fm, and this documentation with the help of community members like you.

#Get Started

?> Basic QMK Configurator
User friendly graphical interfaces, no programming knowledge required.

?> Advanced Use The Source
More powerful, but harder to use.

#Make It Yours

QMK has lots of features to explore, and a good deal of reference documentation to dig through. Most features are taken advantage of by modifying your keymap, and changing the keycodes.

#Need help?

Check out the support page to see how you can get help using QMK.

#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.