mirror of
https://github.com/Keychron/qmk_firmware.git
synced 2024-11-25 18:06:34 +06:00
4e8166750b
* first pass * firmware firmware? * Split out debug + testing docs * tidy up duplicate css * Add extra info to debug example Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Drashna Jaelre <drashna@live.com>
38 lines
1.7 KiB
Markdown
38 lines
1.7 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
|
|
|
|
<div class="flex-container">
|
|
|
|
?> **Basic** [QMK Configurator](newbs_building_firmware_configurator.md) <br>
|
|
User friendly graphical interfaces, no programming knowledge required.
|
|
|
|
?> **Advanced** [Use The Source](newbs.md) <br>
|
|
More powerful, but harder to use.
|
|
|
|
</div>
|
|
|
|
## 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.md), and changing the [keycodes](keycodes.md).
|
|
|
|
## Need help?
|
|
|
|
Check out the [support page](support.md) 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/Uq7gcHh)
|
|
* Contribute to our documentation by clicking "Edit This Page" at the bottom
|
|
* [Translate our documentation into your language](translating.md)
|
|
* [Report a bug](https://github.com/qmk/qmk_firmware/issues/new/choose)
|
|
* [Open a Pull Request](contributing.md)
|