History

undermark5 6499eb6a3c Fixed typo in vscode docs (#10303 ) .vscode/c_cpp_properies.json -> .vscode/c_cpp_properties.json		2020-09-13 14:28:30 +01:00
..
ChangeLog	Add ChangeLog for 2020 Aug 29 Breaking Changes	2020-08-29 14:30:02 -07:00
de	…
es	Remove `DESCRIPTION` (#9732 )	2020-07-16 15:49:18 +10:00
fr-fr	…
gitbook/images	…
he-il	…
ja	[Docs] Update Japanese translation of feature_split_keyboard.md (#10283 )	2020-09-11 13:10:30 -07:00
pt-br	…
ru-ru	…
zh-cn	Remove unnecessary break after return from documentation (#9892 )	2020-07-31 15:58:55 +01:00
.nojekyll	…
CNAME	…
README.md	…
_langs.md	…
_summary.md	Hid joystick interface (#4226 )	2020-08-29 14:30:02 -07:00
adc_driver.md	Change analogRead calls to analogReadPin (#9023 )	2020-08-29 14:30:02 -07:00
api_development_environment.md	…
api_development_overview.md	…
api_docs.md	…
api_overview.md	…
arm_debugging.md	…
breaking_changes.md	update "Breaking Changes" doc	2020-08-29 14:30:02 -07:00
breaking_changes_instructions.md	…
cli.md	…
cli_commands.md	…
cli_configuration.md	…
cli_development.md	…
coding_conventions_c.md	…
coding_conventions_python.md	…
compatible_microcontrollers.md	…
config_options.md	Remove support for Adafruit EZ-Key (#10103 )	2020-08-29 14:30:02 -07:00
configurator_step_by_step.md	…
configurator_troubleshooting.md	…
contributing.md	…
custom_matrix.md	…
custom_quantum_functions.md	Remove unnecessary break after return from documentation (#9892 )	2020-07-31 15:58:55 +01:00
documentation_best_practices.md	[Docs] fix file path (#9540 )	2020-06-25 15:58:36 +10:00
documentation_templates.md	…
driver_installation_zadig.md	MSYS2: Switch to bootloadHID package and bring back avrdude package (#9736 )	2020-07-16 18:01:34 +01:00
eeprom_driver.md	…
faq_build.md	Docs: update ModemManager recommendation (#9328 )	2020-07-07 19:22:38 +01:00
faq_debug.md	…
faq_general.md	…
faq_keymap.md	…
feature_advanced_keycodes.md	…
feature_audio.md	…
feature_auto_shift.md	#define AUTO_SHIFT_SETUP (#8441 )	2020-08-29 14:30:02 -07:00
feature_backlight.md	Remove f072 backlight warning (#10040 )	2020-08-29 14:30:02 -07:00
feature_bluetooth.md	Remove support for Adafruit EZ-Key (#10103 )	2020-08-29 14:30:02 -07:00
feature_bootmagic.md	…
feature_combo.md	…
feature_command.md	…
feature_debounce_type.md	quantum/debounce: rename debouncing algorithms (#9564 )	2020-09-06 13:13:49 -07:00
feature_dip_switch.md	add DIP_SWITCH_MATRIX_GRID support (#8772 )	2020-07-04 23:20:49 +09:00
feature_dynamic_macros.md	Fix typo in docs/feature_dynamic_macros (#10085 )	2020-08-19 22:59:59 +01:00
feature_encoders.md	Adding information to feature_encoders.md (#9486 )	2020-06-21 17:10:01 +10:00
feature_grave_esc.md	…
feature_haptic_feedback.md	…
feature_hd44780.md	…
feature_joystick.md	Allow joysticks to be used without analog pins (#10169 )	2020-08-29 14:30:02 -07:00
feature_key_lock.md	…
feature_layers.md	Redefine IS_LAYER_ON/OFF() as aliases for existing layer functions (#6352 )	2020-07-16 22:27:55 +10:00
feature_layouts.md	…
feature_leader_key.md	Delete trailing period in documentation (#9416 )	2020-06-15 02:49:36 +10:00
feature_led_matrix.md	…
feature_macros.md	[Docs] Improve Unicode documentation (#8676 )	2020-06-20 21:58:48 +01:00
feature_mouse_keys.md	Implemented New MK_COMBINED Functionality (#9557 )	2020-07-21 09:28:38 +10:00
feature_oled_driver.md	Add a method to read the OLED display buffer from user space (#8777 )	2020-08-29 14:30:02 -07:00
feature_pointing_device.md	…
feature_ps2_mouse.md	Add movement hook to ps2_mouse (#8805 )	2020-07-02 21:54:15 +01:00
feature_rawhid.md	…
feature_rgb_matrix.md	Noeeprom functions for rgb_matrix (#9487 )	2020-08-29 14:30:02 -07:00
feature_rgblight.md	Tweak the Christmas animation effect to be less harsh on the eyes (#7648 )	2020-08-29 14:30:02 -07:00
feature_space_cadet.md	…
feature_split_keyboard.md	Replace figures in docs/feature_split_keyboard.md (#10242 )	2020-09-06 21:15:55 -07:00
feature_stenography.md	fix typo (#9695 )	2020-07-11 23:06:33 +10:00
feature_swap_hands.md	…
feature_tap_dance.md	Update features to use Custom Tapping Term when appropriate (#6259 )	2020-08-29 14:30:02 -07:00
feature_terminal.md	…
feature_thermal_printer.md	…
feature_unicode.md	[Docs] Improve Unicode documentation (#8676 )	2020-06-20 21:58:48 +01:00
feature_userspace.md	…
feature_velocikey.md	…
feature_wpm.md	…
flashing.md	Add `st-flash` flash target (#9964 )	2020-08-29 14:30:02 -07:00
flashing_bootloadhid.md	…
fuse.txt	…
getting_started_docker.md	…
getting_started_github.md	…
getting_started_introduction.md	…
getting_started_make_guide.md	Remove support for Adafruit EZ-Key (#10103 )	2020-08-29 14:30:02 -07:00
getting_started_vagrant.md	…
hand_wire.md	…
hardware_avr.md	Remove `DESCRIPTION` (#9732 )	2020-07-16 15:49:18 +10:00
hardware_drivers.md	…
hardware_keyboard_guidelines.md	…
how_a_matrix_works.md	…
how_keyboards_work.md	…
i2c_driver.md	Update i2c_driver.md (#10131 )	2020-08-22 14:06:16 +01:00
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	[Docs] Update ISP Guide (#9748 )	2020-07-18 21:24:23 +01:00
keycodes.md	Issue 9942: Add LSA, RSA, RCS, LSA_T, RSA_T, and RCS_T (#9943 )	2020-08-17 02:08:15 -07:00
keycodes_basic.md	…
keycodes_us_ansi_shifted.md	…
keymap.md	…
mod_tap.md	…
newbs.md	…
newbs_building_firmware.md	…
newbs_building_firmware_configurator.md	…
newbs_flashing.md	…
newbs_getting_started.md	Update newbs MSYS2 pacman instructions (#9445 )	2020-06-21 10:54:53 +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	…
newbs_testing_debugging.md	…
one_shot_keys.md	[Docs] Fix link to mod_tap.md in the one_shot_keys.md file (#9380 )	2020-06-15 02:55:00 -07:00
other_eclipse.md	…
other_vscode.md	Fixed typo in vscode docs (#10303 )	2020-09-13 14:28:30 +01:00
platformdev_chibios_earlyinit.md	Add dual-bank STM32 bootloader support, given GPIO toggle on BOOT0 to charge RC circuit. (#8778 )	2020-08-29 14:30:02 -07:00
platformdev_selecting_arm_mcu.md	Add documentation for selecting an Arm MCU (#9046 )	2020-06-10 23:32:58 +01:00
power.txt	…
pr_checklist.md	Docs/PR_checklist: Reorder, unify and pet-peeves (#10253 )	2020-09-06 13:06:12 +01:00
proton_c_conversion.md	…
qmk.css	…
qmk_custom_dark.css	…
qmk_custom_light.css	…
quantum_keycodes.md	…
redirects.json	…
ref_functions.md	Remove unnecessary break after return from documentation (#9892 )	2020-07-31 15:58:55 +01:00
reference_configurator_support.md	…
reference_glossary.md	fixed link to Eclipse instructions (#9647 )	2020-07-05 08:50:01 +10:00
reference_info_json.md	…
reference_keymap_extras.md	[Keymap Extra] Add French AZERTY (AFNOR - NF Z71-300) (#9644 )	2020-07-08 19:55:02 +01:00
serial_driver.md	…
spi_driver.md	…
support.md	…
sw.js	…
syllabus.md	…
tap_hold.md	Add missing bracket for Tap-Hold code sample (#9675 )	2020-07-08 13:40:13 +10:00
translating.md	…
understanding_qmk.md	…
unit_testing.md	…
usb_nkro.txt	…
ws2812_driver.md	Add support for DMAMUX-capable MCU configuration with WS2812 PWM driver. (#9471 )	2020-08-29 14:30:02 -07: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

Totally new to QMK? There are two ways to get started:

Basic: QMK Configurator
- Just select your keyboard from the dropdown and program your keyboard.
- We have an introductory video you can watch.
- There is also an overview document you can read.
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