You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

37 lines
1.7 KiB

  1. # Quantum Mechanical Keyboard Firmware
  2. ## What is QMK Firmware?
  3. 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.
  4. ## Get Started
  5. <div class="flex-container">
  6. ?> **Basic** [QMK Configurator](newbs_building_firmware_configurator.md) <br>
  7. User friendly graphical interfaces, no programming knowledge required.
  8. ?> **Advanced** [Use The Source](newbs.md) <br>
  9. More powerful, but harder to use.
  10. </div>
  11. ## Make It Yours
  12. 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).
  13. ## Need help?
  14. Check out the [support page](support.md) to see how you can get help using QMK.
  15. ## Give Back
  16. 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.
  17. * Help people out on our forums and chat rooms:
  18. * [/r/olkb](https://www.reddit.com/r/olkb/)
  19. * [Discord Server](https://discord.gg/Uq7gcHh)
  20. * Contribute to our documentation by clicking "Edit This Page" at the bottom
  21. * [Translate our documentation into your language](translating.md)
  22. * [Report a bug](https://github.com/qmk/qmk_firmware/issues/new/choose)
  23. * [Open a Pull Request](contributing.md)