qmk_firmware/docs
lyuts d8c62e4238 Fixed typo in docs. ()
..
gitbook/images RGB improvements ()
README.md Fix these links, as they appear to be broken ()
_summary.md Updates send_string functionality, adds terminal feature ()
adding_a_keyboard_to_qmk.md Minor typo
adding_features_to_qmk.md Doc updates from going through every file
becoming_a_qmk_collaborator.md convert docs to lowercase and underscores
compatible_microcontrollers.md convert docs to lowercase and underscores
config_options.md adds config options md
custom_quantum_functions.md Fix minor formatting issue.
documentation_best_practices.md Doc updates from going through every file
dynamic_macros.md convert docs to lowercase and underscores
eclipse.md Update a bunch of docs
faq.md Overhaul the Getting Started section and add a FAQ section
faq_build.md Fix these links, as they appear to be broken ()
faq_debug.md Fixed typo in docs. ()
faq_general.md Doc updates from going through every file
faq_keymap.md Doc updates from going through every file
feature_audio.md Doc updates from going through every file
feature_auto_shift.md Fixed a few typos and spelling errors in auto shift feature document
feature_backlight.md break up keymaps and quantum keycodes into files by feature
feature_bluetooth.md Doc updates from going through every file
feature_bootmagic.md Edited a minor typo in feature_bootmagic.md.
feature_common_shortcuts.md Fixed typo of "multually" to "mutually"
feature_layouts.md Creates a layouts/ folder for keymaps shared between keyboards ()
feature_leader_key.md Doc updates from going through every file
feature_pointing_device.md Generic Pointing Device ()
feature_ps2_mouse.md Doc updates from going through every file
feature_rgblight.md Fix HSV Color Wheel image on RGB Light page ()
feature_terminal.md Updates send_string functionality, adds terminal feature ()
feature_thermal_printer.md break up keymaps and quantum keycodes into files by feature
features.md Generic Pointing Device ()
fuse.txt convert docs to lowercase and underscores
getting_started_build_tools.md Add shell.nix for NixOS users
getting_started_github.md Overhaul the Getting Started section and add a FAQ section
getting_started_instroduction.md Overhaul the Getting Started section and add a FAQ section
getting_started_make_guide.md Remove all Makefiles from the keyboards directory. ()
getting_started_vagrant.md Overhaul the Getting Started section and add a FAQ section
glossary.md Update links in the glossary
hand_wire.md Remove all Makefiles from the keyboards directory. ()
how_keyboards_work.md Add link to keycodes doc in how_keyboards_work
isp_flashing_guide.md update docs for isp
key_lock.md Added support for locking One Shot modifiers.
keycode.txt Docfix ()
keycodes.md updated keycodes media descriptions
keycodes_basic.md platform descriptions to match master keycodes.md documentation
keycodes_us_ansi_shifted.md break up keymaps and quantum keycodes into files by feature
keymap.md Doc updates from going through every file
macros.md Updates send_string functionality, adds terminal feature ()
mouse_keys.md Merge branch 'master' into docs
porting_your_keyboard_to_qmk.md Doc updates from going through every file
porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md convert docs to lowercase and underscores
power.txt convert docs to lowercase and underscores
quantum_keycodes.md Doc updates from going through every file
redirects.json validates json
space_cadet_shift.md convert docs to lowercase and underscores
stenography.md Add compile error if too many endpoints are defined for the ATmega32U4.
tap_dance.md Reference to rules.mk in tap dance docs added
understanding_qmk.md Added Auto Shift, tap key = normal, hold key = shifted state.
unicode.md add UC_OSX_RALT to make unicode use the Right Alt key on OSX
unit_testing.md convert docs to lowercase and underscores
usb_nkro.txt convert docs to lowercase and underscores

README.md

Quantum Mechanical Keyboard Firmware

What is QMK Firmware?

QMK (Quantum Mechanical Keyboard) is an open source community that maintains QMK Firmware, QMK Flasher, qmk.fm, and these docs. QMK Firmware is a keyboard firmware based on the tmk_keyboard with some useful features for Atmel AVR controllers, and more specifically, the OLKB product line, the ErgoDox EZ keyboard, and the Clueboard product line. It has also been ported to ARM chips using ChibiOS. You can use it to power your own hand-wired or custom keyboard PCB.

How to get it

If you plan on contributing a keymap, keyboard, or features to QMK, the easiest thing to do is fork the repo through Github, and clone your repo locally to make your changes, push them, then open a Pull Request from your fork.

Otherwise, you can either download it directly (zip, tar), or clone it via git (git@github.com:qmk/qmk_firmware.git), or https (https://github.com/qmk/qmk_firmware.git).

How to compile

Before you are able to compile, you'll need to install an environment for AVR or/and ARM development. Once that is complete, you'll use the make command to build a keyboard and keymap with the following notation:

make planck-rev4-default

This would build the rev4 revision of the planck with the default keymap. Not all keyboards have revisions (also called subprojects), in which case, it can be omitted:

make preonic-default

How to customize

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.