History

Joel Challis fc9fb2c775 Allow output of logging when running unit tests (#13556 ) * Initial pass at enabling logging for unit tests * Add to docs * Bind debug for more test types * Force everything * Tidy up slightly		2021-07-25 17:18:09 +01:00
..
ChangeLog	…
de	…
es	[Docs] Use HTTPS for images and links where possible (#11695 )	2021-01-30 22:00:56 +11:00
fr-fr	Cleanup junk characters, part 1 (#13282 )	2021-06-21 11:29:15 +01:00
gitbook/images	…
he-il	…
ja	Remove unwanted notes (#13563 )	2021-07-16 09:37:49 -07:00
ko-kr	…
pt-br	…
ru-ru	[Docs] Use HTTPS for images and links where possible (#11695 )	2021-01-30 22:00:56 +11:00
zh-cn	…
.nojekyll	…
CNAME	…
README.md	…
_langs.md	…
_summary.md	…
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	Update merge sequence to reflect no-ff, no-squash. (#13038 )	2021-06-18 00:05:27 +01:00
breaking_changes_history.md	…
breaking_changes_instructions.md	…
cli.md	…
cli_commands.md	2021 May 29 Breaking Changes Update (#13034 )	2021-05-29 14:38:50 -07:00
cli_configuration.md	…
cli_development.md	…
cli_tab_complete.md	…
coding_conventions_c.md	…
coding_conventions_python.md	…
compatible_microcontrollers.md	…
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	Create a system to map between info.json and config.h/rules.mk (#11548 )	2021-01-31 12:46:00 -08:00
documentation_best_practices.md	…
documentation_templates.md	…
driver_installation_zadig.md	Improve driver installation docs (#13562 )	2021-07-17 02:49:33 +10:00
eeprom_driver.md	…
faq_build.md	…
faq_debug.md	Allow output of logging when running unit tests (#13556 )	2021-07-25 17:18:09 +01:00
faq_general.md	…
faq_keymap.md	…
faq_misc.md	…
feature_advanced_keycodes.md	Additional documentation for GUI mod combo (#13266 )	2021-06-22 12:41:57 +10:00
feature_audio.md	Document user song list file (#13101 )	2021-06-15 22:31:06 -07:00
feature_auto_shift.md	…
feature_backlight.md	…
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	…
feature_grave_esc.md	…
feature_haptic_feedback.md	…
feature_hd44780.md	…
feature_joystick.md	…
feature_key_lock.md	…
feature_layers.md	…
feature_layouts.md	…
feature_leader_key.md	…
feature_led_indicators.md	[Docs] Added note about no split support (#12512 )	2021-07-20 10:11:49 -07:00
feature_led_matrix.md	Top level heading for common config (LED Matrix) (#13153 )	2021-06-15 22:07:24 -07:00
feature_macros.md	…
feature_midi.md	…
feature_mouse_keys.md	…
feature_oled_driver.md	OLED driver tweaks (#13215 )	2021-06-17 17:14:23 +10:00
feature_pointing_device.md	…
feature_ps2_mouse.md	…
feature_rawhid.md	…
feature_rgb_matrix.md	[Docs] RGB Matrix Caps Lock and Layer indicator example (#13367 )	2021-07-03 01:07:01 -07:00
feature_rgblight.md	…
feature_sequencer.md	…
feature_space_cadet.md	…
feature_split_keyboard.md	[Docs] Update feature_split_keyboard.md (#13205 )	2021-06-13 20:20:19 -07:00
feature_stenography.md	…
feature_swap_hands.md	…
feature_tap_dance.md	…
feature_terminal.md	…
feature_thermal_printer.md	…
feature_unicode.md	…
feature_userspace.md	…
feature_velocikey.md	…
feature_wpm.md	…
flashing.md	2021 May 29 Breaking Changes Update (#13034 )	2021-05-29 14:38:50 -07:00
flashing_bootloadhid.md	Install bootloadHid as part of qmk_install (#7463 )	2019-11-28 15:29:11 +00:00
fuse.txt	…
getting_started_docker.md	…
getting_started_github.md	…
getting_started_introduction.md	…
getting_started_make_guide.md	…
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	rename api docs to internals	2018-03-26 11:43:37 -07:00
internals_sysex_tools.md	…
isp_flashing_guide.md	…
keycodes.md	[Docs] added list of MIDI keycodes (#13159 )	2021-07-04 17:34:20 -07:00
keycodes_basic.md	…
keycodes_us_ansi_shifted.md	…
keymap.md	[Docs] Clarify layer transparency keymap.md (#9081 )	2020-05-16 00:35:19 -07:00
mod_tap.md	Add Mac centric Shift and Alt + GUI Macros (#13107 )	2021-06-19 19:14:19 -07:00
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	…
newbs_git_using_your_master_branch.md	…
newbs_learn_more_resources.md	…
newbs_testing_debugging.md	…
one_shot_keys.md	[Docs] Update one_shot_keys.md (#12291 )	2021-06-15 20:35:31 -07:00
other_eclipse.md	…
other_vscode.md	…
platformdev_chibios_earlyinit.md	…
platformdev_selecting_arm_mcu.md	…
power.txt	…
pr_checklist.md	[Docs] pr_checklist: fix capitalization of Vial (#13301 )	2021-06-22 17:45:13 -07: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	UART driver refactor (#11637 )	2021-01-27 17:42:49 +11:00
understanding_qmk.md	…
unit_testing.md	Allow output of logging when running unit tests (#13556 )	2021-07-25 17:18:09 +01:00
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