History

Drashna Jael're af936c6ae6 Merge remote-tracking branch 'origin/master' into develop		2021-12-08 08:17:55 -08:00
..
ChangeLog	Changelog 2021q4 (#15325 )	2021-11-28 10:41:48 +11:00
de	…
es	Purge uGFX. (#14720 )	2021-10-07 10:57:48 +11:00
fr-fr	Move tmk_core/common/<plat> (#13918 )	2021-11-19 10:41:02 -08:00
gitbook/images	…
he-il	Purge uGFX. (#14720 )	2021-10-07 10:57:48 +11:00
ja	Remove use of __flash due to LTO issues (#15268 )	2021-11-24 18:38:49 +11:00
ko-kr	…
pt-br	…
ru-ru	Purge uGFX. (#14720 )	2021-10-07 10:57:48 +11:00
zh-cn	Move tmk_core/common/<plat> (#13918 )	2021-11-19 10:41:02 -08:00
.nojekyll	…
CNAME	…
README.md	…
_langs.md	Fix hebrew emoji in langs.md (#15140 )	2021-11-13 17:18:02 +00:00
_summary.md	Changelog 2021q4 (#15325 )	2021-11-28 10:41:48 +11:00
adc_driver.md	…
api_development_environment.md	…
api_development_overview.md	…
api_docs.md	…
api_overview.md	…
arm_debugging.md	…
audio_driver.md	…
breaking_changes.md	Fix last merge date (#15327 )	2021-11-28 12:59:48 +11:00
breaking_changes_history.md	Changelog 2021q4 (#15325 )	2021-11-28 10:41:48 +11:00
breaking_changes_instructions.md	…
chibios_upgrade_instructions.md	Update to ChibiOS 20.3.4, support builds against trunk (#14208 )	2021-11-03 08:26:40 +11:00
cli.md	…
cli_commands.md	Merge remote-tracking branch 'upstream/master' into develop	2021-11-05 08:55:55 +11:00
cli_configuration.md	…
cli_development.md	…
cli_tab_complete.md	Fix Typo in documentation (#14942 )	2021-10-24 23:32:42 +01:00
coding_conventions_c.md	…
coding_conventions_python.md	Refactor new-keyboard to be python3.7 compatible (#14707 )	2021-11-05 08:14:43 +11:00
compatible_microcontrollers.md	Westberrytech pr (#14422 )	2021-11-27 09:28:18 +11:00
config_options.md	New feature: `DYNAMIC_TAPPING_TERM_ENABLE` (#11036 )	2021-11-26 07:06:50 +11:00
configurator_architecture.md	…
configurator_default_keymaps.md	Basic keycode overhaul (#14726 )	2021-11-03 22:22:17 -07:00
configurator_diagram.drawio	…
configurator_diagram.svg	…
configurator_step_by_step.md	…
configurator_troubleshooting.md	…
contributing.md	…
custom_matrix.md	…
custom_quantum_functions.md	Add support for deferred executors. (#14859 )	2021-11-15 18:21:09 +00:00
data_driven_config.md	…
documentation_best_practices.md	…
documentation_templates.md	…
driver_installation_zadig.md	[Core] Add support for RISC-V builds and GD32VF103 MCU (#12508 )	2021-10-18 16:23:20 +11:00
easy_maker.md	…
eeprom_driver.md	…
faq_build.md	…
faq_debug.md	…
faq_general.md	…
faq_keymap.md	Basic keycode overhaul (#14726 )	2021-11-03 22:22:17 -07:00
faq_misc.md	Remove `BOOTMAGIC_ENABLE = lite` option (#15002 )	2021-11-05 08:18:09 +11:00
feature_advanced_keycodes.md	…
feature_audio.md	…
feature_auto_shift.md	Add Retro Shift (Auto Shift for Tap Hold via Retro Tapping) and Custom Auto Shifts (#11059 )	2021-11-25 23:12:14 +11:00
feature_backlight.md	…
feature_bluetooth.md	Improve Adafruit BLE configuration defines (#14749 )	2021-10-08 16:15:20 +01:00
feature_bootmagic.md	Remove `BOOTMAGIC_ENABLE = lite` option (#15002 )	2021-11-05 08:18:09 +11:00
feature_combo.md	Merge remote-tracking branch 'origin/master' into develop	2021-11-22 20:02:13 +00:00
feature_command.md	…
feature_debounce_type.md	…
feature_digitizer.md	…
feature_dip_switch.md	…
feature_dynamic_macros.md	…
feature_encoders.md	[Bug] Revert Assymmetrical Split Encoder support (#12090 ) (#15311 )	2021-11-27 14:40:09 +11:00
feature_grave_esc.md	Basic keycode overhaul (#14726 )	2021-11-03 22:22:17 -07:00
feature_haptic_feedback.md	Basic keycode overhaul (#14726 )	2021-11-03 22:22:17 -07:00
feature_hd44780.md	…
feature_joystick.md	…
feature_key_lock.md	Added cancel_key_lock function (#15321 )	2021-11-29 00:17:07 -08:00
feature_key_overrides.md	Basic keycode overhaul (#14726 )	2021-11-03 22:22:17 -07:00
feature_layers.md	Move tmk_core/common/<plat> (#13918 )	2021-11-19 10:41:02 -08:00
feature_layouts.md	…
feature_leader_key.md	…
feature_led_indicators.md	[Docs] add sync options heading, update led indicators (#14441 )	2021-09-15 10:11:25 -07:00
feature_led_matrix.md	Remove use of __flash due to LTO issues (#15268 )	2021-11-24 18:38:49 +11:00
feature_macros.md	Macros in JSON keymaps (#14374 )	2021-11-22 11:11:35 -08:00
feature_midi.md	…
feature_mouse_keys.md	…
feature_oled_driver.md	Merge remote-tracking branch 'origin/master' into develop	2021-11-02 06:19:36 +00:00
feature_pointing_device.md	Expand rotational range for PMW3360 Optical Sensor (#15431 )	2021-12-08 07:38:09 -08:00
feature_programmable_button.md	…
feature_ps2_mouse.md	Align PS/2 GPIO defines (#14745 )	2021-10-20 20:07:40 +01:00
feature_rawhid.md	…
feature_rgb_matrix.md	Remove use of __flash due to LTO issues (#15268 )	2021-11-24 18:38:49 +11:00
feature_rgblight.md	…
feature_sequencer.md	…
feature_space_cadet.md	…
feature_split_keyboard.md	[Docs] add sync options heading, update led indicators (#14441 )	2021-09-15 10:11:25 -07:00
feature_st7565.md	…
feature_stenography.md	Merge remote-tracking branch 'origin/master' into develop	2021-11-17 22:31:15 +00:00
feature_swap_hands.md	Document swap-hands tap-toggle feature (#15229 )	2021-11-29 00:23:37 -08:00
feature_tap_dance.md	Basic keycode overhaul (#14726 )	2021-11-03 22:22:17 -07:00
feature_terminal.md	…
feature_thermal_printer.md	…
feature_unicode.md	…
feature_userspace.md	Enable CLI flashing via mdloader (#14729 )	2021-10-15 22:07:33 +01:00
feature_velocikey.md	Remove `BOOTMAGIC_ENABLE = lite` option (#15002 )	2021-11-05 08:18:09 +11:00
feature_wpm.md	Reimplements WPM feature to be smaller & precise (#13902 )	2021-11-16 05:40:52 +11:00
flashing.md	Fix RESET not working for keyboards with Kiibohd bootloader (#15430 )	2021-12-07 20:36:39 -08:00
flashing_bootloadhid.md	…
fuse.txt	…
getting_started_docker.md	…
getting_started_github.md	Purge uGFX. (#14720 )	2021-10-07 10:57:48 +11:00
getting_started_introduction.md	…
getting_started_make_guide.md	Add support for deferred executors. (#14859 )	2021-11-15 18:21:09 +00:00
getting_started_vagrant.md	…
hand_wire.md	…
hardware_avr.md	…
hardware_drivers.md	Purge uGFX. (#14720 )	2021-10-07 10:57:48 +11:00
hardware_keyboard_guidelines.md	Purge uGFX. (#14720 )	2021-10-07 10:57:48 +11:00
how_a_matrix_works.md	…
how_keyboards_work.md	…
i2c_driver.md	i2c_master: Add support for reading/writing to 16-bit registers (#14289 )	2021-10-07 10:29:35 +11:00
index.html	…
internals_defines.md	…
internals_gpio_control.md	Move tmk_core/common/<plat> (#13918 )	2021-11-19 10:41:02 -08:00
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	Rework ISP flashing guide (#14938 )	2021-11-05 14:42:08 +11:00
keycodes.md	Implement MAGIC_TOGGLE_CONTROL_CAPSLOCK (#15368 )	2021-11-30 17:34:08 -08:00
keycodes_basic.md	Basic keycode overhaul (#14726 )	2021-11-03 22:22:17 -07:00
keycodes_magic.md	Implement MAGIC_TOGGLE_CONTROL_CAPSLOCK (#15368 )	2021-11-30 17:34:08 -08:00
keycodes_us_ansi_shifted.md	…
keymap.md	Basic keycode overhaul (#14726 )	2021-11-03 22:22:17 -07:00
mod_tap.md	[Docs] Correct logic of tap hold statement (#14992 )	2021-11-12 14:14:28 -08:00
newbs.md	…
newbs_building_firmware.md	…
newbs_building_firmware_configurator.md	…
newbs_flashing.md	…
newbs_getting_started.md	[Docs] Add instructions to create keymap before proceeding (#14945 )	2021-10-27 08:03:00 -07:00
newbs_git_best_practices.md	…
newbs_git_resolving_merge_conflicts.md	…
newbs_git_resynchronize_a_branch.md	…
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	…
platformdev_chibios_earlyinit.md	…
platformdev_selecting_arm_mcu.md	…
power.txt	…
pr_checklist.md	Changelog 2021q4 (#15325 )	2021-11-28 10:41:48 +11:00
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	Basic keycode overhaul (#14726 )	2021-11-03 22:22:17 -07:00
reference_glossary.md	…
reference_info_json.md	[Docs] Clean up reference_info_json.md (#14806 )	2021-10-15 12:45:33 +11:00
reference_keymap_extras.md	…
serial_driver.md	…
spi_driver.md	…
squeezing_avr.md	[Docs] Squeezing space out of AVR (#15243 )	2021-11-23 08:14:00 +11:00
support.md	…
sw.js	…
syllabus.md	[Docs] Squeezing space out of AVR (#15243 )	2021-11-23 08:14:00 +11:00
tap_hold.md	New feature: `DYNAMIC_TAPPING_TERM_ENABLE` (#11036 )	2021-11-26 07:06:50 +11:00
translating.md	…
uart_driver.md	Update UART driver API (#14839 )	2021-11-13 18:23:14 +00:00
understanding_qmk.md	[Docs] Reorder functions in Understanding QMK (#15357 )	2021-11-30 11:24:21 -08:00
unit_testing.md	Remove SERIAL_LINK feature (#14727 )	2021-10-07 12:32:05 +11:00
usb_nkro.txt	…
ws2812_driver.md	Documentation typo fix (#15298 )	2021-11-25 20:13:16 +00:00

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.

Help people out on our forums and chat rooms:
- /r/olkb
- Discord Server
Contribute to our documentation by clicking "Edit This Page" at the bottom
Translate our documentation into your language
Report a bug
Open a Pull Request