History

coliss86 837a57b3c5 Adjust the hierarchy of chapter `Deferred Execution` (#18075 )		2022-08-16 11:41:31 -07:00
..
ChangeLog	Breaking changes for 2022q2. (#17221 )	2022-05-29 07:50:21 +10:00
gitbook/images	…
internals	Move Doxygen docs to subdirectory (#16561 )	2022-03-07 11:22:22 +00:00
ja	Merge remote-tracking branch 'origin/master' into develop	2022-03-08 04:17:05 +00:00
zh-cn	Fix docs typo (#17254 )	2022-05-30 23:05:57 +01:00
.nojekyll	…
CNAME	…
README.md	…
_langs.md	…
_summary.md	[Docs] Building with GitHub Userspace (#16271 )	2022-08-06 16:36:31 +10:00
adc_driver.md	…
api_development_environment.md	…
api_development_overview.md	…
api_docs.md	[Docs] Address some typos (also in moonlander matrix.c) (#16248 )	2022-02-06 17:36:44 +00:00
api_overview.md	…
arm_debugging.md	…
audio_driver.md	[Docs] Fix tables in Audio driver document (#17780 )	2022-07-25 00:00:51 +01:00
breaking_changes.md	Add texts for Discord Events to be created post-merge. (#17944 )	2022-08-13 17:51:45 -07:00
breaking_changes_history.md	stub changelog	2022-05-24 01:55:34 +01:00
breaking_changes_instructions.md	…
chibios_upgrade_instructions.md	…
cli.md	…
cli_commands.md	Quantum Painter (#10174 )	2022-04-13 18:00:18 +10:00
cli_configuration.md	…
cli_development.md	Some docs improvements (#15845 )	2022-03-05 15:58:50 +11:00
cli_tab_complete.md	Add Zsh note for tab complete (#17226 )	2022-07-02 21:59:59 +10:00
coding_conventions_c.md	…
coding_conventions_python.md	…
compatible_microcontrollers.md	Inform people that things may not work. (#17391 )	2022-06-14 20:15:01 +10:00
config_options.md	[Core] Add compile/make macro to core (#15959 )	2022-03-17 21:19:34 +00:00
configurator_architecture.md	…
configurator_default_keymaps.md	…
configurator_diagram.drawio	…
configurator_diagram.svg	…
configurator_step_by_step.md	…
configurator_troubleshooting.md	…
contributing.md	…
custom_matrix.md	…
custom_quantum_functions.md	Adjust the hierarchy of chapter `Deferred Execution` (#18075 )	2022-08-16 11:41:31 -07:00
data_driven_config.md	Change data driven "str" type to represent a quoted string literal (#16516 )	2022-03-04 13:25:24 +00:00
documentation_best_practices.md	…
documentation_templates.md	…
driver_installation_zadig.md	…
easy_maker.md	…
eeprom_driver.md	…
faq_build.md	…
faq_debug.md	…
faq_general.md	…
faq_keymap.md	Keymap FAQ updates (#17130 )	2022-05-18 04:48:59 +10:00
faq_misc.md	…
feature_advanced_keycodes.md	Add trailing parens to `get_oneshot_mods` in feature_advanced_keycodes.md (#17211 )	2022-05-31 21:31:47 +10:00
feature_audio.md	…
feature_auto_shift.md	…
feature_backlight.md	…
feature_bluetooth.md	Rename `AdafruitBLE` to `BluefruitLE` (#16127 )	2022-01-30 17:29:42 +00:00
feature_bootmagic.md	Add split keyboard example for Bootmagic Lite (#16349 )	2022-03-15 01:31:17 -07:00
feature_caps_word.md	[Core] Add Caps Word feature to core (#16588 )	2022-05-14 16:00:32 +10:00
feature_combo.md	…
feature_command.md	…
feature_debounce_type.md	…
feature_digitizer.md	…
feature_dip_switch.md	…
feature_dynamic_macros.md	…
feature_encoders.md	[Docs] Refactor code examples (#18003 )	2022-08-12 17:27:24 -07:00
feature_grave_esc.md	Rename some Quantum keycodes (#15968 )	2022-01-22 03:34:15 +00:00
feature_haptic_feedback.md	[Feature] Add support for multiple switchs/solenoids to Haptic Feedback engine (#15657 )	2022-05-15 21:24:35 +10:00
feature_hd44780.md	HD44780 driver rework (#16370 )	2022-03-19 17:57:22 +11:00
feature_joystick.md	Joystick feature updates (#16732 )	2022-03-26 18:38:09 +00:00
feature_key_lock.md	…
feature_key_overrides.md	…
feature_layers.md	…
feature_layouts.md	…
feature_leader_key.md	[Docs] Update feature_leader_key.md (#16344 )	2022-02-21 09:08:36 -08:00
feature_led_indicators.md	Refine LED indicator documentation (#16304 )	2022-04-16 17:36:07 -07:00
feature_led_matrix.md	[Docs] Align LED Matrix docs with RGB matrix docs (#17140 )	2022-05-20 09:13:40 -07:00
feature_macros.md	[Docs] feature_macro.md: minor formatting fix (#16205 )	2022-02-05 08:15:21 +11:00
feature_midi.md	Update feature_midi.md (#17390 )	2022-06-14 11:12:52 +01:00
feature_mouse_keys.md	Merge remote-tracking branch 'origin/master' into develop	2022-02-05 11:45:18 +00:00
feature_oled_driver.md	[Docs] OLED documentation edits (#15977 )	2022-01-27 15:56:20 +00:00
feature_pointing_device.md	Add support for multiple sensors to pmw3360 (#15996 )	2022-04-19 20:29:17 +10:00
feature_programmable_button.md	…
feature_ps2_mouse.md	…
feature_rawhid.md	…
feature_rgb_matrix.md	[Docs] Refactor code examples (#18003 )	2022-08-12 17:27:24 -07:00
feature_rgblight.md	rgblight: Add functions to stop blinking one or all but one layer (#16859 )	2022-04-17 00:02:32 +02:00
feature_secure.md	Add basic secure docs (#17577 )	2022-07-13 00:06:19 +01:00
feature_sequencer.md	…
feature_space_cadet.md	…
feature_split_keyboard.md	Add a note about using differents MCU family (#17416 )	2022-06-19 08:32:22 +10:00
feature_st7565.md	…
feature_stenography.md	[Docs] Update Steno Keycode Table (#17155 )	2022-05-20 09:09:00 -07:00
feature_swap_hands.md	Add support for encoder mapping. (#13286 )	2022-03-09 19:29:00 +11:00
feature_tap_dance.md	[Docs] Address some typos (also in moonlander matrix.c) (#16248 )	2022-02-06 17:36:44 +00:00
feature_terminal.md	…
feature_thermal_printer.md	…
feature_unicode.md	Remove `send_unicode_hex_string()` (#16518 )	2022-03-04 11:04:45 +00:00
feature_userspace.md	…
feature_velocikey.md	…
feature_wpm.md	…
flash_driver.md	Added external spi flash driver. (#15419 )	2022-02-11 20:26:16 +00:00
flashing.md	Fix docs typo (#17254 )	2022-05-30 23:05:57 +01:00
flashing_bootloadhid.md	…
fuse.txt	…
getting_started_docker.md	…
getting_started_github.md	…
getting_started_introduction.md	…
getting_started_make_guide.md	…
getting_started_vagrant.md	…
gpio_control.md	Move Doxygen docs to subdirectory (#16561 )	2022-03-07 11:22:22 +00:00
hand_wire.md	…
hardware_drivers.md	…
hardware_keyboard_guidelines.md	add 'info_config.h' into docs/hardware_keyboard_guidelines.md (#16247 )	2022-02-06 17:37:59 +00:00
how_a_matrix_works.md	…
how_keyboards_work.md	docs: reflect systemd's change in language (#17322 )	2022-06-06 23:29:59 +01:00
i2c_driver.md	Fix i2c driver doc: Incorrect name (#16898 )	2022-04-20 18:10:20 +01:00
index.html	Fix anchors with <code> in table of content (#15169 )	2022-05-14 23:08:32 +01:00
isp_flashing_guide.md	ISP flashing guide: add instructions for flashing STM32duino bootloader (#16568 )	2022-03-13 23:55:47 +00:00
keycodes.md	[Core] Add Caps Word feature to core (#16588 )	2022-05-14 16:00:32 +10:00
keycodes_basic.md	…
keycodes_magic.md	…
keycodes_us_ansi_shifted.md	[Docs] Address some typos (also in moonlander matrix.c) (#16248 )	2022-02-06 17:36:44 +00:00
keymap.md	Some docs improvements (#15845 )	2022-03-05 15:58:50 +11:00
mod_tap.md	[Docs] Address some typos (also in moonlander matrix.c) (#16248 )	2022-02-06 17:36:44 +00:00
newbs.md	…
newbs_building_firmware.md	[Docs] Update newbs_building_firmware.md (#16333 )	2022-02-21 09:08:07 -08:00
newbs_building_firmware_configurator.md	…
newbs_building_firmware_workflow.md	[Docs] Building with GitHub Userspace (#16271 )	2022-08-06 16:36:31 +10:00
newbs_flashing.md	Add note about qmk doctor in newbs_flashing.md (#15688 )	2022-07-02 22:48:44 +10:00
newbs_getting_started.md	Attempt to discourage manual MSYS install for new users (#17556 )	2022-07-04 00:41:00 +01: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	[Docs] Refactor code examples (#18003 )	2022-08-12 17:27:24 -07:00
newbs_testing_debugging.md	…
one_shot_keys.md	…
other_eclipse.md	[Docs] Address some typos (also in moonlander matrix.c) (#16248 )	2022-02-06 17:36:44 +00:00
other_vscode.md	Update other_vscode.md (#17317 )	2022-06-08 02:47:57 +01:00
platformdev_blackpill_f411.md	[Docs] Add information about WeAct Blackpill F411 (#16755 )	2022-07-27 14:49:12 +01:00
platformdev_chibios_earlyinit.md	…
platformdev_selecting_arm_mcu.md	…
porting_your_keyboard_to_qmk.md	Align new-keyboard with recent schema updates (#16378 )	2022-02-16 20:58:40 +00:00
power.txt	…
pr_checklist.md	[Docs] update pr_checklist.md with info about data-driven (#18068 )	2022-08-16 18:01:56 +01:00
proton_c_conversion.md	Move Doxygen docs to subdirectory (#16561 )	2022-03-07 11:22:22 +00:00
qmk.css	…
qmk_custom_dark.css	…
qmk_custom_light.css	…
quantum_keycodes.md	[Core] Add Reboot keycode to core (#15990 )	2022-05-14 13:35:49 +10:00
quantum_painter.md	Quantum Painter (#10174 )	2022-04-13 18:00:18 +10:00
quantum_painter_qff.md	Quantum Painter (#10174 )	2022-04-13 18:00:18 +10:00
quantum_painter_qgf.md	Quantum Painter (#10174 )	2022-04-13 18:00:18 +10:00
quantum_painter_rle.md	Quantum Painter (#10174 )	2022-04-13 18:00:18 +10:00
redirects.json	…
ref_functions.md	Update ref_functions.md (replaced deprecated `RESET`) (#17436 )	2022-06-23 02:26:08 +01:00
reference_configurator_support.md	…
reference_glossary.md	…
reference_info_json.md	Add basic secure docs (#17577 )	2022-07-13 00:06:19 +01:00
reference_keymap_extras.md	Rename keymap_extras headers for consistency (#16939 )	2022-05-15 21:27:01 +10:00
serial_driver.md	…
spi_driver.md	…
squeezing_avr.md	[Core] Allow usage of AVRs minimal printf library (#16266 )	2022-04-22 18:13:31 +10:00
support.md	…
sw.js	…
syllabus.md	…
tap_hold.md	Add GET_TAPPING_TERM macro to reduce duplicate code (#16681 )	2022-04-16 11:24:09 -07:00
translating.md	…
uart_driver.md	…
understanding_qmk.md	Some docs improvements (#15845 )	2022-03-05 15:58:50 +11:00
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