History

Drashna Jaelre f0b30e0027 Make Swap Hands use PROGMEM (#12284 ) This converts the array that the Swap Hands feature uses to use PROGMEM, and to read from that array, as such. Since this array never changes at runtime, there is no reason to keep it in memory. Especially for AVR boards, as memory is a precious resource.		2021-05-09 23:21:09 -07:00
..
ChangeLog	Change `BOOTMAGIC_ENABLE=yes` to use Bootmagic Lite (#12172 )	2021-04-12 21:18:52 +02:00
de	…
es	…
fr-fr	…
gitbook/images	…
he-il	…
ja	Make Swap Hands use PROGMEM (#12284 )	2021-05-09 23:21:09 -07:00
ko-kr	…
pt-br	…
ru-ru	…
zh-cn	…
.nojekyll	…
CNAME	…
README.md	…
_langs.md	…
_summary.md	Add support for tab completion (#12411 )	2021-04-14 19:00:22 -07:00
adc_driver.md	Update ADC driver for STM32F1xx, STM32F3xx, STM32F4xx (#12403 )	2021-04-25 11:15:37 +10:00
api_development_environment.md	…
api_development_overview.md	…
api_docs.md	…
api_overview.md	…
arm_debugging.md	…
audio_driver.md	…
breaking_changes.md	Fix Breaking Change date (#12272 )	2021-04-09 12:41:29 +10:00
breaking_changes_history.md	…
breaking_changes_instructions.md	…
cli.md	…
cli_commands.md	New command: qmk console (#12828 )	2021-05-08 20:56:07 -07:00
cli_configuration.md	…
cli_development.md	…
cli_tab_complete.md	Add support for tab completion (#12411 )	2021-04-14 19:00:22 -07:00
coding_conventions_c.md	…
coding_conventions_python.md	…
compatible_microcontrollers.md	Add STM32L433 and L443 support (#12063 )	2021-04-26 13:07:15 +10:00
config_options.md	…
configurator_default_keymaps.md	…
configurator_step_by_step.md	…
configurator_troubleshooting.md	…
contributing.md	…
custom_matrix.md	…
custom_quantum_functions.md	…
data_driven_config.md	…
documentation_best_practices.md	…
documentation_templates.md	…
driver_installation_zadig.md	…
eeprom_driver.md	…
faq_build.md	…
faq_debug.md	…
faq_general.md	…
faq_keymap.md	…
faq_misc.md	…
feature_advanced_keycodes.md	…
feature_audio.md	A few small typo fixes in docs (#12524 )	2021-04-11 12:50:45 +02:00
feature_auto_shift.md	Add Per Key functionality for AutoShift (#11536 )	2021-04-19 20:34:14 -07:00
feature_backlight.md	A few small typo fixes in docs (#12524 )	2021-04-11 12:50:45 +02:00
feature_bluetooth.md	…
feature_bootmagic.md	…
feature_combo.md	…
feature_command.md	…
feature_debounce_type.md	…
feature_dip_switch.md	…
feature_dynamic_macros.md	…
feature_encoders.md	Add docs on multiple encoders sharing pins (#11678 )	2021-05-06 20:17:10 +02:00
feature_grave_esc.md	…
feature_haptic_feedback.md	…
feature_hd44780.md	…
feature_joystick.md	…
feature_key_lock.md	…
feature_layers.md	Improve upon the 'Caveats' section of the Layers and Mod-Tap documentation (#12306 )	2021-03-25 22:44:28 +11:00
feature_layouts.md	…
feature_leader_key.md	feat: infinite timeout for leader key (#6580 )	2021-04-25 10:22:47 +10:00
feature_led_indicators.md	…
feature_led_matrix.md	Terrazzo: Fix wrong LED Matrix function names (#12561 )	2021-04-13 19:51:31 +10:00
feature_macros.md	…
feature_mouse_keys.md	…
feature_oled_driver.md	Added OLED fade out support (#12086 )	2021-05-08 12:27:13 +02:00
feature_pointing_device.md	…
feature_ps2_mouse.md	…
feature_rawhid.md	…
feature_rgb_matrix.md	Change RGB/LED Matrix to use a simple define for USB suspend (#12697 )	2021-04-29 12:39:54 +10:00
feature_rgblight.md	Add missing RGB_MODE_TWINKLE / RGB_M_TW keycodes (#11935 )	2021-04-15 19:32:17 -04:00
feature_sequencer.md	…
feature_space_cadet.md	…
feature_split_keyboard.md	…
feature_stenography.md	…
feature_swap_hands.md	Make Swap Hands use PROGMEM (#12284 )	2021-05-09 23:21:09 -07:00
feature_tap_dance.md	…
feature_terminal.md	…
feature_thermal_printer.md	…
feature_unicode.md	…
feature_userspace.md	…
feature_velocikey.md	…
feature_wpm.md	Enhancement of WPM feature (#11727 )	2021-04-18 23:26:37 -07:00
flashing.md	Add initial support for tinyuf2 bootloader (when hosted on F411 blackpill) (#12600 )	2021-04-25 13:40:56 +10:00
flashing_bootloadhid.md	…
fuse.txt	…
getting_started_docker.md	…
getting_started_github.md	…
getting_started_introduction.md	…
getting_started_make_guide.md	Documentation update (#12484 )	2021-04-11 12:49:12 +02:00
getting_started_vagrant.md	…
hand_wire.md	…
hardware_avr.md	…
hardware_drivers.md	…
hardware_keyboard_guidelines.md	…
how_a_matrix_works.md	…
how_keyboards_work.md	…
i2c_driver.md	…
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	…
keycodes_basic.md	…
keycodes_us_ansi_shifted.md	…
keymap.md	…
mod_tap.md	Improve upon the 'Caveats' section of the Layers and Mod-Tap documentation (#12306 )	2021-03-25 22:44:28 +11:00
newbs.md	…
newbs_building_firmware.md	…
newbs_building_firmware_configurator.md	…
newbs_flashing.md	A few small typo fixes in docs (#12524 )	2021-04-11 12:50:45 +02:00
newbs_getting_started.md	Update FreeBSD install method (#12815 )	2021-05-07 19:22:05 +02: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	eclipse: recommend changing the default project make target (#12447 )	2021-04-19 02:20:17 -07:00
other_vscode.md	…
platformdev_chibios_earlyinit.md	…
platformdev_selecting_arm_mcu.md	…
power.txt	…
pr_checklist.md	Add additional info to PR Checklist (#12630 )	2021-04-20 20:12:57 +02: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	…
reference_glossary.md	…
reference_info_json.md	…
reference_keymap_extras.md	…
serial_driver.md	…
spi_driver.md	…
support.md	…
sw.js	…
syllabus.md	…
tap_hold.md	…
translating.md	…
uart_driver.md	…
understanding_qmk.md	…
unit_testing.md	…
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.

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