mirror of
https://github.com/Keychron/qmk_firmware.git
synced 2024-12-11 20:58:15 +06:00
39 lines
1.6 KiB
Markdown
39 lines
1.6 KiB
Markdown
# 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](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.
|
|
|
|
## Get Started
|
|
|
|
::: tip Basic
|
|
[QMK Configurator](newbs_building_firmware_configurator)
|
|
|
|
User friendly graphical interfaces, no programming knowledge required.
|
|
:::
|
|
|
|
::: warning Advanced
|
|
[Use The Source](newbs)
|
|
|
|
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](keymap), and changing the [keycodes](keycodes).
|
|
|
|
## Need help?
|
|
|
|
Check out the [support page](support) 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.
|
|
|
|
* Help people out on our forums and chat rooms:
|
|
* [/r/olkb](https://www.reddit.com/r/olkb/)
|
|
* [Discord Server](https://discord.gg/qmk)
|
|
* Contribute to our documentation by clicking "Edit This Page" at the bottom
|
|
* [Report a bug](https://github.com/qmk/qmk_firmware/issues/new/choose)
|
|
* [Open a Pull Request](contributing)
|