You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
QMK Bot 713c32fa5e Merge remote-tracking branch 'origin/master' into develop 4 years ago
..
ChangeLog Bootmagic lite docs clarity. (#14204) 4 years ago
de Remove bin/qmk (#14231) 4 years ago
es Purge uGFX. (#14720) 4 years ago
fr-fr Purge uGFX. (#14720) 4 years ago
gitbook/images
he-il Purge uGFX. (#14720) 4 years ago
ja Merge remote-tracking branch 'origin/master' into develop 4 years ago
ko-kr [Core] [Docs] Remove travis-ci references (#13916) 4 years ago
pt-br [Core] [Docs] Remove travis-ci references (#13916) 4 years ago
ru-ru Purge uGFX. (#14720) 4 years ago
zh-cn Purge uGFX. (#14720) 4 years ago
.nojekyll
CNAME
README.md
_langs.md
_summary.md Add Support for USB programmable buttons (#12950) 4 years ago
adc_driver.md
api_development_environment.md
api_development_overview.md
api_docs.md
api_overview.md
arm_debugging.md
audio_driver.md [Docs] Clean up some code block languages (#14434) 4 years ago
breaking_changes.md 2021Q3 pre-merge `develop` changelog, keyboard aliases (#14198) 4 years ago
breaking_changes_history.md 2021Q3 pre-merge `develop` changelog, keyboard aliases (#14198) 4 years ago
breaking_changes_instructions.md
chibios_upgrade_instructions.md
cli.md
cli_commands.md New CLI subcommand to create clang-compatible compilation database (`compile_commands.json`) (#14370) 4 years ago
cli_configuration.md
cli_development.md [Docs] Clean up some code block languages (#14434) 4 years ago
cli_tab_complete.md
coding_conventions_c.md
coding_conventions_python.md
compatible_microcontrollers.md Change `MK66F18` -> `MK66FX1M0` (#14659) 4 years ago
config_options.md [Core] Fix "6kro enable" and clarify naming (#14563) 4 years ago
configurator_architecture.md
configurator_default_keymaps.md [Docs] Clean up some code block languages (#14434) 4 years ago
configurator_diagram.drawio
configurator_diagram.svg
configurator_step_by_step.md
configurator_troubleshooting.md
contributing.md Remove bin/qmk (#14231) 4 years ago
custom_matrix.md [Docs] Clean up some code block languages (#14434) 4 years ago
custom_quantum_functions.md [Docs] update suspend_*_user examples (#14542) 4 years ago
data_driven_config.md
documentation_best_practices.md
documentation_templates.md
driver_installation_zadig.md Change USBasp and bootloadHID bootloaders to lowercase (#14354) 4 years ago
easy_maker.md
eeprom_driver.md
faq_build.md
faq_debug.md [Docs] Clean up some code block languages (#14434) 4 years ago
faq_general.md
faq_keymap.md [Docs] Update path to keycode.h (#14263) 4 years ago
faq_misc.md Remove sysex API (#14723) 4 years ago
feature_advanced_keycodes.md
feature_audio.md Fixup Audio startup and add to documents (#13606) 4 years ago
feature_auto_shift.md
feature_backlight.md [Docs] Clean up some code block languages (#14434) 4 years ago
feature_bluetooth.md Improve Adafruit BLE configuration defines (#14749) 4 years ago
feature_bootmagic.md
feature_combo.md
feature_command.md
feature_debounce_type.md
feature_digitizer.md [Docs] Clean up some code block languages (#14434) 4 years ago
feature_dip_switch.md Added right vs left specific pin assignments for dip switch (#13074) 4 years ago
feature_dynamic_macros.md
feature_encoders.md [Docs] Modify encoder_update_user example to return false (#14541) 4 years ago
feature_grave_esc.md
feature_haptic_feedback.md Add LM() keys to the list of keys disabled by NO_HAPTIC_MOD (#14181) 4 years ago
feature_hd44780.md
feature_joystick.md [Docs] Clean up some code block languages (#14434) 4 years ago
feature_key_lock.md
feature_key_overrides.md Documentation: Fix links in key overrides (#14228) 4 years ago
feature_layers.md
feature_layouts.md [Docs] Clean up some code block languages (#14434) 4 years ago
feature_leader_key.md
feature_led_indicators.md [Docs] add sync options heading, update led indicators (#14441) 4 years ago
feature_led_matrix.md [Docs] fix wrong directory for RGB Matrix animations (#14494) 4 years ago
feature_macros.md
feature_midi.md [Docs] Clean up some code block languages (#14434) 4 years ago
feature_mouse_keys.md
feature_oled_driver.md [Docs] fixed incorrect amount of steps for oled usage (#13519) 4 years ago
feature_pointing_device.md [Docs] Clean up some code block languages (#14434) 4 years ago
feature_programmable_button.md Add Support for USB programmable buttons (#12950) 4 years ago
feature_ps2_mouse.md [Docs] Clean up some code block languages (#14434) 4 years ago
feature_rawhid.md [Docs] Clean up some code block languages (#14434) 4 years ago
feature_rgb_matrix.md Merge remote-tracking branch 'upstream/master' into develop 4 years ago
feature_rgblight.md
feature_sequencer.md
feature_space_cadet.md
feature_split_keyboard.md [Docs] add sync options heading, update led indicators (#14441) 4 years ago
feature_st7565.md
feature_stenography.md [Docs] Clean up some code block languages (#14434) 4 years ago
feature_swap_hands.md [Docs] Clean up some code block languages (#14434) 4 years ago
feature_tap_dance.md Fix link from feature_tap_dance.md to tapping term settings (#14741) 4 years ago
feature_terminal.md
feature_thermal_printer.md
feature_unicode.md
feature_userspace.md [Docs] Clean up some code block languages (#14434) 4 years ago
feature_velocikey.md Highlight keycode (#14317) 4 years ago
feature_wpm.md
flashing.md Change USBasp and bootloadHID bootloaders to lowercase (#14354) 4 years ago
flashing_bootloadhid.md [Docs] Clean up some code block languages (#14434) 4 years ago
fuse.txt
getting_started_docker.md [Docs] Clean up some code block languages (#14434) 4 years ago
getting_started_github.md Purge uGFX. (#14720) 4 years ago
getting_started_introduction.md
getting_started_make_guide.md Remove sysex API (#14723) 4 years ago
getting_started_vagrant.md [Docs] Clean up some code block languages (#14434) 4 years ago
hand_wire.md
hardware_avr.md
hardware_drivers.md Purge uGFX. (#14720) 4 years ago
hardware_keyboard_guidelines.md Purge uGFX. (#14720) 4 years ago
how_a_matrix_works.md
how_keyboards_work.md [Docs] Clean up some code block languages (#14434) 4 years ago
i2c_driver.md i2c_master: Add support for reading/writing to 16-bit registers (#14289) 4 years ago
index.html
internals_defines.md
internals_gpio_control.md
internals_input_callback_reg.md
internals_midi_device.md
internals_midi_device_setup_process.md
internals_midi_util.md
internals_send_functions.md
internals_sysex_tools.md
isp_flashing_guide.md
keycodes.md Add Support for USB programmable buttons (#12950) 4 years ago
keycodes_basic.md
keycodes_magic.md Add a toggle key for GUI On/Off in Magic feature (#13830) 4 years ago
keycodes_us_ansi_shifted.md
keymap.md
mod_tap.md Document examples on intercepting Mod-Tap (#14502) 4 years ago
newbs.md
newbs_building_firmware.md
newbs_building_firmware_configurator.md
newbs_flashing.md
newbs_getting_started.md
newbs_git_best_practices.md
newbs_git_resolving_merge_conflicts.md
newbs_git_resynchronize_a_branch.md [Docs] Clean up some code block languages (#14434) 4 years ago
newbs_git_using_your_master_branch.md
newbs_learn_more_resources.md
newbs_testing_debugging.md
one_shot_keys.md
other_eclipse.md
other_vscode.md [Core] [Docs] Remove travis-ci references (#13916) 4 years ago
platformdev_chibios_earlyinit.md
platformdev_selecting_arm_mcu.md
power.txt
pr_checklist.md More PR checklist updates (#14705) 4 years ago
proton_c_conversion.md
qmk.css
qmk_custom_dark.css
qmk_custom_light.css
quantum_keycodes.md
redirects.json
ref_functions.md
reference_configurator_support.md
reference_glossary.md Fix Space Cadet md link (#14300) 4 years ago
reference_info_json.md Remove width, height and key_count from info.json (#14274) 4 years ago
reference_keymap_extras.md
serial_driver.md Make solo half of split keyboards (more) usable. (#13523) 4 years ago
spi_driver.md
support.md
sw.js
syllabus.md
tap_hold.md
translating.md
uart_driver.md
understanding_qmk.md Purge uGFX. (#14720) 4 years ago
unit_testing.md Remove SERIAL_LINK feature (#14727) 4 years ago
usb_nkro.txt
ws2812_driver.md

README.md

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, QMK Configurator, QMK Toolbox, qmk.fm, and this documentation with the help of community members like you.

Get Started

?> Basic QMK Configurator
User friendly graphical interfaces, no programming knowledge required.

?> Advanced Use The Source
More powerful, but harder to use.

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, and changing the keycodes.

Need help?

Check out the support page 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.