History

Albert Y 8a4fae3b32 [Docs] Recommend the use of RGB matrix functions for code (#15744 ) * Recommend the use of functions instead of keycodes * Commit suggested review Co-authored-by: Nick Brassel <nick@tzarc.org> Co-authored-by: Nick Brassel <nick@tzarc.org>		2022-01-11 03:23:28 +11:00
..
ChangeLog	Changelog 2021q4 (#15325 )	2021-11-28 10:41:48 +11:00
gitbook/images	…
ja	Remove use of __flash due to LTO issues (#15268 )	2021-11-24 18:38:49 +11:00
zh-cn	Move tmk_core/common/<plat> (#13918 )	2021-11-19 10:41:02 -08:00
.nojekyll	…
CNAME	…
README.md	…
_langs.md	Remove stale docs translations (#15737 )	2022-01-04 18:11:24 -08: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	[Docs] Clean up some code block languages (#14434 )	2021-09-14 13:16:24 +01:00
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	Add test filter to 'qmk pytest' (#15432 )	2021-12-09 17:42:11 +11:00
cli_configuration.md	…
cli_development.md	[Docs] Clean up some code block languages (#14434 )	2021-09-14 13:16:24 +01:00
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	[Docs] Fix Header formatting in compatible mcu doc (#15438 )	2021-12-09 14:49:10 +11:00
config_options.md	New feature: `DYNAMIC_TAPPING_TERM_ENABLE` (#11036 )	2021-11-26 07:06:50 +11:00
configurator_architecture.md	Architecture documentation for Configurator and API (#13935 )	2021-08-10 07:47:53 -07:00
configurator_default_keymaps.md	Basic keycode overhaul (#14726 )	2021-11-03 22:22:17 -07:00
configurator_diagram.drawio	Architecture documentation for Configurator and API (#13935 )	2021-08-10 07:47:53 -07:00
configurator_diagram.svg	Architecture documentation for Configurator and API (#13935 )	2021-08-10 07:47:53 -07:00
configurator_step_by_step.md	…
configurator_troubleshooting.md	…
contributing.md	Remove bin/qmk (#14231 )	2021-08-29 16:50:22 -07:00
custom_matrix.md	[Docs] Clean up some code block languages (#14434 )	2021-09-14 13:16:24 +01:00
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	[Keyboard] ez_maker/directpins for easy one-offs in qmk_configurator (#13321 )	2021-08-14 08:42:59 -07:00
eeprom_driver.md	eeprom_i2c driver: added EXTERNAL_EEPROM_WP_PIN configuration option. (#12617 )	2021-06-21 19:34:28 -07:00
faq_build.md	…
faq_debug.md	doc/faq_debug: qmk cli can also be used to print debug messages (#15528 )	2021-12-22 06:27:25 -08:00
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	Additional documentation for GUI mod combo (#13266 )	2021-06-22 12:41:57 +10:00
feature_audio.md	Fixup Audio startup and add to documents (#13606 )	2021-08-15 21:51:50 +01:00
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	[Docs] Clean up some code block languages (#14434 )	2021-09-14 13:16:24 +01:00
feature_bluetooth.md	[Docs] Updated typo on feature_bluetooth.md (#15466 )	2021-12-13 20:55:53 -08:00
feature_bootmagic.md	Remove `BOOTMAGIC_ENABLE = lite` option (#15002 )	2021-11-05 08:18:09 +11:00
feature_combo.md	Link Macro example for COMBO_ACTION documentation (#15164 )	2021-12-27 14:07:00 +11:00
feature_command.md	Remove Full Bootmagic (#13846 )	2021-08-06 23:59:56 -07:00
feature_debounce_type.md	Remove backwards compatibility of debounce names (#13877 )	2021-08-09 19:46:18 +01:00
feature_digitizer.md	[Docs] Clean up some code block languages (#14434 )	2021-09-14 13:16:24 +01:00
feature_dip_switch.md	Added right vs left specific pin assignments for dip switch (#13074 )	2021-08-19 18:39:15 +01:00
feature_dynamic_macros.md	…
feature_encoders.md	Volume as default encoder documentation example (#15678 )	2022-01-02 00:07:22 -08: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	[Docs] Clean up some code block languages (#14434 )	2021-09-14 13:16:24 +01:00
feature_key_lock.md	…
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	[Docs] Clean up some code block languages (#14434 )	2021-09-14 13:16:24 +01:00
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	[Docs] Note the order of enumerated custom keycodes (#15706 )	2022-01-03 09:07:58 -08:00
feature_midi.md	[Docs] Clean up some code block languages (#14434 )	2021-09-14 13:16:24 +01:00
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	[Docs] Add drag scrolling example to Pointing device docs page (#15715 )	2022-01-06 00:30:22 -08:00
feature_programmable_button.md	Add Support for USB programmable buttons (#12950 )	2021-09-15 08:40:22 -07:00
feature_ps2_mouse.md	Align PS/2 GPIO defines (#14745 )	2021-10-20 20:07:40 +01:00
feature_rawhid.md	[Docs] Clean up some code block languages (#14434 )	2021-09-14 13:16:24 +01:00
feature_rgb_matrix.md	[Docs] Recommend the use of RGB matrix functions for code (#15744 )	2022-01-11 03:23:28 +11:00
feature_rgblight.md	[Docs] Recommend the use of RGB light functions for code (#15745 )	2022-01-11 03:23:07 +11:00
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	ST7565 invert (#13237 )	2021-06-19 18:51:35 +10:00
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	[Docs] Update feature_tap_dance.md (#14931 )	2022-01-08 19:26:44 -08: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	[Docs] Clean up some code block languages (#14434 )	2021-09-14 13:16:24 +01:00
fuse.txt	…
getting_started_docker.md	[Docs] Clean up some code block languages (#14434 )	2021-09-14 13:16:24 +01:00
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	[Docs] Clean up some code block languages (#14434 )	2021-09-14 13:16:24 +01:00
hand_wire.md	[Docs] Added information on soldering diodes in parallel (#13117 )	2021-07-29 22:56:27 -07:00
hardware_avr.md	Port new_keyboard.sh to CLI (#13706 )	2021-07-30 21:57:40 +01:00
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	[Docs] Clean up some code block languages (#14434 )	2021-09-14 13:16:24 +01:00
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	Remove stale docs translations (#15737 )	2022-01-04 18:11:24 -08:00
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	New feature: `DYNAMIC_TAPPING_TERM_ENABLE` (#11036 )	2021-11-26 07:06:50 +11:00
keycodes_basic.md	Basic keycode overhaul (#14726 )	2021-11-03 22:22:17 -07:00
keycodes_magic.md	Add a toggle key for GUI On/Off in Magic feature (#13830 )	2021-08-18 08:47:50 +10: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	[Docs] Clean up some code block languages (#14434 )	2021-09-14 13:16:24 +01:00
newbs_git_using_your_master_branch.md	…
newbs_learn_more_resources.md	…
newbs_testing_debugging.md	…
one_shot_keys.md	fix: Fix typo in documentation for one shot keys. ON_TOGG -> OS_TOGG (#13754 )	2021-07-28 12:00:55 +01:00
other_eclipse.md	…
other_vscode.md	[Core] [Docs] Remove travis-ci references (#13916 )	2021-08-20 23:31:26 +01:00
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	fix typo (#15569 )	2021-12-24 20:10:12 +00:00
reference_configurator_support.md	Basic keycode overhaul (#14726 )	2021-11-03 22:22:17 -07:00
reference_glossary.md	Fix Space Cadet md link (#14300 )	2021-09-04 15:01:56 +01:00
reference_info_json.md	[Docs] Clean up reference_info_json.md (#14806 )	2021-10-15 12:45:33 +11:00
reference_keymap_extras.md	Rework keymap_extras docs (#13949 )	2021-08-15 00:18:20 +10:00
serial_driver.md	Make solo half of split keyboards (more) usable. (#13523 )	2021-08-22 10:51:17 +10:00
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