qmk_firmware

QMK firmware for my keyboards (Corne, Sweep Ferris) and trackball (Ploopy Adept)
Log | Files | Refs | Submodules | LICENSE

index.md (1620B)


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