Skip to content

Latest commit

 

History

History
 
 

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
gitbook/images
gitbook/images
 
 
README.md
README.md
 
 
_summary.md
_summary.md
 
 
becoming_a_qmk_collaborator.md
becoming_a_qmk_collaborator.md
 
 
compatible_microcontrollers.md
compatible_microcontrollers.md
 
 
config_options.md
config_options.md
 
 
contributing.md
contributing.md
 
 
custom_quantum_functions.md
custom_quantum_functions.md
 
 
documentation_best_practices.md
documentation_best_practices.md
 
 
documentation_templates.md
documentation_templates.md
 
 
eclipse.md
eclipse.md
 
 
faq.md
faq.md
 
 
faq_build.md
faq_build.md
 
 
faq_debug.md
faq_debug.md
 
 
faq_general.md
faq_general.md
 
 
faq_keymap.md
faq_keymap.md
 
 
feature_advanced_keycodes.md
feature_advanced_keycodes.md
 
 
feature_audio.md
feature_audio.md
 
 
feature_auto_shift.md
feature_auto_shift.md
 
 
feature_backlight.md
feature_backlight.md
 
 
feature_bluetooth.md
feature_bluetooth.md
 
 
feature_bootmagic.md
feature_bootmagic.md
 
 
feature_dynamic_macros.md
feature_dynamic_macros.md
 
 
feature_grave_esc.md
feature_grave_esc.md
 
 
feature_key_lock.md
feature_key_lock.md
 
 
feature_layouts.md
feature_layouts.md
 
 
feature_leader_key.md
feature_leader_key.md
 
 
feature_macros.md
feature_macros.md
 
 
feature_mouse_keys.md
feature_mouse_keys.md
 
 
feature_pointing_device.md
feature_pointing_device.md
 
 
feature_ps2_mouse.md
feature_ps2_mouse.md
 
 
feature_rgblight.md
feature_rgblight.md
 
 
feature_space_cadet.md
feature_space_cadet.md
 
 
feature_space_shift_cadet.md
feature_space_shift_cadet.md
 
 
feature_stenography.md
feature_stenography.md
 
 
feature_tap_dance.md
feature_tap_dance.md
 
 
feature_terminal.md
feature_terminal.md
 
 
feature_thermal_printer.md
feature_thermal_printer.md
 
 
feature_unicode.md
feature_unicode.md
 
 
feature_userspace.md
feature_userspace.md
 
 
features.md
features.md
 
 
flashing.md
flashing.md
 
 
fuse.txt
fuse.txt
 
 
getting_started_build_tools.md
getting_started_build_tools.md
 
 
getting_started_github.md
getting_started_github.md
 
 
getting_started_introduction.md
getting_started_introduction.md
 
 
getting_started_make_guide.md
getting_started_make_guide.md
 
 
getting_started_vagrant.md
getting_started_vagrant.md
 
 
glossary.md
glossary.md
 
 
hand_wire.md
hand_wire.md
 
 
hardware.md
hardware.md
 
 
hardware_avr.md
hardware_avr.md
 
 
hardware_drivers.md
hardware_drivers.md
 
 
hardware_keyboard_guidelines.md
hardware_keyboard_guidelines.md
 
 
how_keyboards_work.md
how_keyboards_work.md
 
 
isp_flashing_guide.md
isp_flashing_guide.md
 
 
keycode.txt
keycode.txt
 
 
keycodes.md
keycodes.md
 
 
keycodes_basic.md
keycodes_basic.md
 
 
keycodes_us_ansi_shifted.md
keycodes_us_ansi_shifted.md
 
 
keymap.md
keymap.md
 
 
porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md
porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md
 
 
power.txt
power.txt
 
 
quantum_keycodes.md
quantum_keycodes.md
 
 
redirects.json
redirects.json
 
 
understanding_qmk.md
understanding_qmk.md
 
 
unit_testing.md
unit_testing.md
 
 
usb_nkro.txt
usb_nkro.txt
 
 

README.md

Quantum Mechanical Keyboard Firmware

What is QMK 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 {#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 {#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 or folders), in which case, it can be omitted:

make preonic:default

How to Customize {#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.