James Young 6af58fc25e clean up links to keycode references in newbs_building_firmware_configurator.md 6 лет назад
..
ChangeLog 26eef35f07 2020 February 29 Breaking Changes Update (#8064) 6 лет назад
de 170261328e Add language prefixes to docs sidebar entries and readmes (#7406) 6 лет назад
es d1c0710dec remove unused docs 6 лет назад
fr-fr 52c18ef026 [Docs] fix docs (#7642) 6 лет назад
gitbook 4580d3a730 RGB improvements (#1684) 9 лет назад
he-il d1c0710dec remove unused docs 6 лет назад
ja 21715210e2 [Docs] translated 'feature_tap_dance.md' to japanese. (#8137) 6 лет назад
pt-br 10e8ed7430 [Docs] add README translation in portuguese (#7016) 6 лет назад
ru-ru d1c0710dec remove unused docs 6 лет назад
zh-cn 6a165c41cb [Docs] doc update zh-cn (#8147) 6 лет назад
.nojekyll 9e5676650e Use docsfy to replace gitbook 8 лет назад
CNAME 4d26137e2a Create CNAME 8 лет назад
README.md 3f1e47dbcd rework the index page 6 лет назад
_langs.md 10e8ed7430 [Docs] add README translation in portuguese (#7016) 6 лет назад
_summary.md 3f1e47dbcd rework the index page 6 лет назад
adc_driver.md a8320f20f7 Improve support and docs for ADC driver (#7191) 6 лет назад
arm_debugging.md 52c18ef026 [Docs] fix docs (#7642) 6 лет назад
breaking_changes.md f513a9193c Fix the Breaking Changes doc again 6 лет назад
breaking_changes_instructions.md 72d7661b30 suggestions by skullydazed 6 лет назад
cli.md cdb5c074d3 remove some unnecessary external links 6 лет назад
cli_configuration.md d569f08771 Configuration system for CLI (#6708) 6 лет назад
cli_development.md f7bdc54c69 Add flake8 to our test suite and fix all errors (#7379) 6 лет назад
coding_conventions_c.md f275ffbdfc Minor grammar and filename fixes in docs (#7559) 6 лет назад
coding_conventions_python.md 58d27cf404 Add a note explaining how to run tests 6 лет назад
compatible_microcontrollers.md 5414ff709f [Doc] Tidy up compatible MCUs docs (#7295) 6 лет назад
config_options.md b949343b78 New feature: PERMISSIVE_HOLD_PER_KEY (#7994) 6 лет назад
contributing.md 3c190f8927 Improve docs "Edit Document" footer 6 лет назад
custom_matrix.md 6e710426a4 Add docs for 'CUSTOM_MATRIX = lite' (#7906) 6 лет назад
custom_quantum_functions.md 7f388b6553 Add per-key IGNORE_MOD_TAP_INTERRUPT feature (#7838) 6 лет назад
documentation_best_practices.md 303f425c6b Fix up info boxes. 8 лет назад
documentation_templates.md 7b6c8e89ca Doc fix to conform with #7221 (#7392) 6 лет назад
driver_installation_zadig.md 80ded60cad Add a short explanation to Zadig the troubleshooting section (#7110) 6 лет назад
eeprom_driver.md d13ada1162 Add customisable EEPROM driver selection (#7274) 6 лет назад
faq_build.md a52e55ec09 [Docs] Update macOS related issues in docs (#7744) 6 лет назад
faq_debug.md 770a4ee729 [Docs] Remove some outdated FAQ items (#7607) 6 лет назад
faq_general.md 5bb3fe7a35 Remove unanswered/unnecessary FAQ item 6 лет назад
faq_keymap.md 770a4ee729 [Docs] Remove some outdated FAQ items (#7607) 6 лет назад
feature_advanced_keycodes.md b949343b78 New feature: PERMISSIVE_HOLD_PER_KEY (#7994) 6 лет назад
feature_audio.md d534c72a54 Added keycodes for swapping and unswapping the Control and OS keys (#6110) 7 лет назад
feature_auto_shift.md e9c44e396d Smallish overhaul of Auto-Shift feature (#6067) 6 лет назад
feature_backlight.md 26eef35f07 2020 February 29 Breaking Changes Update (#8064) 6 лет назад
feature_bluetooth.md 908aede957 Update feature_bluetooth.md (#7193) 6 лет назад
feature_bootmagic.md 3ad389de55 Add short aliases for Magic keycodes (#7541) 6 лет назад
feature_combo.md 57540af102 Change "yu" to "you" in combo docs (#6510) 7 лет назад
feature_command.md a2e91ebec9 Update IS_COMMAND definitions to use MOD_MASK_SHIFT (#6348) 7 лет назад
feature_debounce_type.md 872744f5ab Update debounce docs (#7355) 6 лет назад
feature_dip_switch.md dab4967f1b Add Dip Switch as a core feature (#6140) 7 лет назад
feature_dynamic_macros.md 542cb0a8ce [Core] Convert Dynamic Macro to a Core Feature (#5948) 6 лет назад
feature_encoders.md 26eef35f07 2020 February 29 Breaking Changes Update (#8064) 6 лет назад
feature_grave_esc.md 3510d8dc8d Document an annoyance with Grave Escape and macOS Terminal (#5483) 7 лет назад
feature_haptic_feedback.md f275ffbdfc Minor grammar and filename fixes in docs (#7559) 6 лет назад
feature_hd44780.md b23f6011c3 Remove build option firmware size impacts (#6947) 6 лет назад
feature_key_lock.md 6560dffc05 update one shot keys link (#7020) 6 лет назад
feature_layouts.md 40e67a3074 Add a mechanism for force building a particular community layout (#5027) 7 лет назад
feature_leader_key.md 5a6737a778 Send string keycode tweaks (#7471) 6 лет назад
feature_led_matrix.md 24df54b807 Add documentation for led matrix 7 лет назад
feature_macros.md 444fd3b1cc Add support for delays in send_string. (#8244) 6 лет назад
feature_mouse_keys.md 4856552f8b Update mouse keys docs (#5653) 7 лет назад
feature_oled_driver.md 9456832a3b Fix out of bound OLED font access (#8145) 6 лет назад
feature_pointing_device.md af37bb2f78 Fix some of the more obvious typos 8 лет назад
feature_ps2_mouse.md c73d6f6ac8 [Docs] Removed dead link (#6922) 6 лет назад
feature_rgb_matrix.md a1452db98a Configuration values for starting HSV and speed (#7740) 6 лет назад
feature_rgblight.md f9521ffa21 Add shift-to-invert to remaining directional RGB_* keycode pairs (#7484) 6 лет назад
feature_space_cadet.md d16db69367 Added mod carry over from press to release. (#5866) 7 лет назад
feature_split_keyboard.md 307be48de9 Reduce SPLIT_USB_TIMEOUT by 500ms (#7637) 6 лет назад
feature_stenography.md c0baf2a964 Improve state/chord handling and clean up namespace 8 лет назад
feature_swap_hands.md fd085837e1 fix swap_hands keycodes in documentation (#3588) 8 лет назад
feature_tap_dance.md 634b277b07 [Docs] Explain Tap Dance interruption (#5520) 6 лет назад
feature_terminal.md b23f6011c3 Remove build option firmware size impacts (#6947) 6 лет назад
feature_thermal_printer.md 4c675a83ba Format keycode tables 8 лет назад
feature_unicode.md bb8d4b4d23 `send_unicode_string()`: Add support for code points > 0xFFFF (#8236) 6 лет назад
feature_userspace.md 5a6737a778 Send string keycode tweaks (#7471) 6 лет назад
feature_velocikey.md c1c5922aae Velocikey: Match RGB animation speed to typing speed (#3754) 7 лет назад
flashing.md 0e6f78547e [Docs] Update flashing information to include :flash target (#6999) 6 лет назад
flashing_bootloadhid.md 235da6973d Install bootloadHid as part of qmk_install (#7463) 6 лет назад
fuse.txt ca01d94005 convert docs to lowercase and underscores 9 лет назад
getting_started_getting_help.md 48913153c3 Replace gitter links with Discord. (#3368) 8 лет назад
getting_started_github.md 52c18ef026 [Docs] fix docs (#7642) 6 лет назад
getting_started_introduction.md 09c7304bd9 [Docs] update git command and directory name of documents (#7619) 6 лет назад
getting_started_make_guide.md 6e710426a4 Add docs for 'CUSTOM_MATRIX = lite' (#7906) 6 лет назад
getting_started_vagrant.md dfdd9e821b [Docs] Update getting_started_vagrant.md (#7203) 6 лет назад
hand_wire.md 19f73483d8 [Docs] Fixed internal links on Handwire page (#7154) 6 лет назад
hardware_avr.md f87908228a Remove apostrophe from various abbreviations' plural forms (#7050) 6 лет назад
hardware_drivers.md d13ada1162 Add customisable EEPROM driver selection (#7274) 6 лет назад
hardware_keyboard_guidelines.md de386e5972 Fixed typos in documentation (#6871) 6 лет назад
how_keyboards_work.md d5316e9714 Update URL for `60-keyboard.hwdb` (#7185) 6 лет назад
i2c_driver.md e6a6b1f122 [Docs] Update i2c_driver.md (#6665) 7 лет назад
index.html d1c18086d2 wip 6 лет назад
internals_defines.md ae7284edb8 rename api docs to internals 8 лет назад
internals_gpio_control.md 403c139b34 [Docs] Add AVR and ARM examples to GPIO Commands (#6942) 6 лет назад
internals_input_callback_reg.md ae7284edb8 rename api docs to internals 8 лет назад
internals_midi_device.md ae7284edb8 rename api docs to internals 8 лет назад
internals_midi_device_setup_process.md ae7284edb8 rename api docs to internals 8 лет назад
internals_midi_util.md ae7284edb8 rename api docs to internals 8 лет назад
internals_send_functions.md ae7284edb8 rename api docs to internals 8 лет назад
internals_sysex_tools.md ae7284edb8 rename api docs to internals 8 лет назад
isp_flashing_guide.md abd36de5ad [Docs] Update ISP Flashing guide (#8149) 6 лет назад
keycodes.md cdb5c074d3 remove some unnecessary external links 6 лет назад
keycodes_basic.md 606813b72d Remove obsolete note about media keys in MacOS (#6631) 6 лет назад
keycodes_us_ansi_shifted.md 40de65eac4 Backslash-escape pipe character in keycode lists (#7157) 6 лет назад
keymap.md c534a4c775 [Docs] Smallish overhaul of the docs (#5281) 7 лет назад
newbs.md b54722cc63 Change newbs.md to link to the new newbs_git_best_practices.md instead of newbs_best_practices.md. (#7633) 6 лет назад
newbs_building_firmware.md dd04079098 Fixed a small typo (#7743) 6 лет назад
newbs_building_firmware_configurator.md 6af58fc25e clean up links to keycode references in newbs_building_firmware_configurator.md 6 лет назад
newbs_flashing.md 0e6f78547e [Docs] Update flashing information to include :flash target (#6999) 6 лет назад
newbs_getting_started.md 5b14456082 more wip 6 лет назад
newbs_git_best_practices.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) 6 лет назад
newbs_git_resolving_merge_conflicts.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) 6 лет назад
newbs_git_resynchronize_a_branch.md 26a823082b [Docs] Fix minor differences in docs/newbs_git_resynchronize_a_branch.md (#7728) 6 лет назад
newbs_git_using_your_master_branch.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) 6 лет назад
newbs_learn_more_resources.md 480651cf9d Docs: Adding QMK Git Conventions doc; formatting cleanup on Learning Resources doc (#3902) 7 лет назад
newbs_testing_debugging.md feb116c4f3 [Docs] Replace Switch Hitter link with Wayback Machine link (#7009) 6 лет назад
other_eclipse.md e9ace14878 [Docs] Add VSCode guide to docs (#5124) 7 лет назад
other_vscode.md e9ace14878 [Docs] Add VSCode guide to docs (#5124) 7 лет назад
power.txt bb53635f33 Trim trailing whitespace 8 лет назад
proton_c_conversion.md 1af31a0523 Update feature support for Proton C (#7596) 6 лет назад
qmk.css ccc87421e7 Some more tweaks to make everything look nice 8 лет назад
quantum_keycodes.md a73c38112d Move Grave Escape, Lock and Leader keycodes into their own sect… (#8093) 6 лет назад
redirects.json d569f08771 Configuration system for CLI (#6708) 6 лет назад
ref_functions.md b62e160a89 Additional changes for Layer State typedef compatibility (#5906) 7 лет назад
reference_configurator_support.md 9cc5841a91 Update reference_configurator_support.md 7 лет назад
reference_glossary.md f87908228a Remove apostrophe from various abbreviations' plural forms (#7050) 6 лет назад
reference_info_json.md bcb1815420 Add label to the info.json reference 7 лет назад
sidebar.css 7d49a17781 override hamburger placement 8 лет назад
support.md cdb5c074d3 remove some unnecessary external links 6 лет назад
sw.js 303f425c6b Fix up info boxes. 8 лет назад
translating.md 7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) 6 лет назад
understanding_qmk.md f87908228a Remove apostrophe from various abbreviations' plural forms (#7050) 6 лет назад
unit_testing.md bb53635f33 Trim trailing whitespace 8 лет назад
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores 9 лет назад
ws2812_driver.md f74c769a19 PWM DMA based RGB Underglow for STM32 (#7928) 6 лет назад

README.md

Quantum Mechanical Keyboard Firmware

Current Version Build Status Discord Docs Status GitHub contributors GitHub forks

What is QMK Firmware?

QMK (Quantum Mechanical Keyboard) is an open source community centered around developing computer input devices. Early on the community was keyboard focused, but has now grown to include mice and MIDI devices as well. The community maintains QMK Firmware, QMK Configurator, QMK Toolbox, qmk.fm, and this documentation.

Get Started

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

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.