skullY 54c58ea6de Add explicit id tags to externally linked headers 5 yıl önce
..
ChangeLog 26eef35f07 2020 February 29 Breaking Changes Update (#8064) 5 yıl önce
de 54c58ea6de Add explicit id tags to externally linked headers 5 yıl önce
es 54c58ea6de Add explicit id tags to externally linked headers 5 yıl önce
fr-fr 54c58ea6de Add explicit id tags to externally linked headers 5 yıl önce
gitbook 4580d3a730 RGB improvements (#1684) 7 yıl önce
he-il 54c58ea6de Add explicit id tags to externally linked headers 5 yıl önce
ja 54c58ea6de Add explicit id tags to externally linked headers 5 yıl önce
pt-br 54c58ea6de Add explicit id tags to externally linked headers 5 yıl önce
ru-ru 54c58ea6de Add explicit id tags to externally linked headers 5 yıl önce
zh-cn 54c58ea6de Add explicit id tags to externally linked headers 5 yıl önce
.nojekyll 9e5676650e Use docsfy to replace gitbook 7 yıl önce
CNAME 4d26137e2a Create CNAME 7 yıl önce
README.md a701c15d87 Rework the newbs guide around the qmk cli 5 yıl önce
_langs.md 10e8ed7430 [Docs] add README translation in portuguese (#7016) 5 yıl önce
_summary.md 906bdce6ce split Hand Wire Preamble to a separate doc 5 yıl önce
adc_driver.md a8320f20f7 Improve support and docs for ADC driver (#7191) 5 yıl önce
api_development_environment.md 99850aabca Add API documentation 5 yıl önce
api_development_overview.md 99850aabca Add API documentation 5 yıl önce
api_docs.md 99850aabca Add API documentation 5 yıl önce
api_overview.md 99850aabca Add API documentation 5 yıl önce
arm_debugging.md 52c18ef026 [Docs] fix docs (#7642) 5 yıl önce
breaking_changes.md f513a9193c Fix the Breaking Changes doc again 5 yıl önce
breaking_changes_instructions.md 72d7661b30 suggestions by skullydazed 5 yıl önce
cli.md cdb5c074d3 remove some unnecessary external links 5 yıl önce
cli_dev_configuration.md 86f6405574 More sidebar organization 5 yıl önce
cli_development.md f7bdc54c69 Add flake8 to our test suite and fix all errors (#7379) 5 yıl önce
coding_conventions_c.md f275ffbdfc Minor grammar and filename fixes in docs (#7559) 5 yıl önce
coding_conventions_python.md 58d27cf404 Add a note explaining how to run tests 5 yıl önce
compatible_microcontrollers.md 5414ff709f [Doc] Tidy up compatible MCUs docs (#7295) 5 yıl önce
config_options.md 54c58ea6de Add explicit id tags to externally linked headers 5 yıl önce
configurator_step_by_step.md d5f34c4810 Polish Configurator section 5 yıl önce
configurator_troubleshooting.md d5f34c4810 Polish Configurator section 5 yıl önce
contributing.md 54c58ea6de Add explicit id tags to externally linked headers 5 yıl önce
custom_matrix.md 6e710426a4 Add docs for 'CUSTOM_MATRIX = lite' (#7906) 5 yıl önce
custom_quantum_functions.md 54c58ea6de Add explicit id tags to externally linked headers 5 yıl önce
documentation_best_practices.md 303f425c6b Fix up info boxes. 7 yıl önce
documentation_templates.md 54c58ea6de Add explicit id tags to externally linked headers 5 yıl önce
driver_installation_zadig.md 80ded60cad Add a short explanation to Zadig the troubleshooting section (#7110) 5 yıl önce
eeprom_driver.md d13ada1162 Add customisable EEPROM driver selection (#7274) 5 yıl önce
faq_build.md a52e55ec09 [Docs] Update macOS related issues in docs (#7744) 5 yıl önce
faq_debug.md 770a4ee729 [Docs] Remove some outdated FAQ items (#7607) 5 yıl önce
faq_general.md a701c15d87 Rework the newbs guide around the qmk cli 5 yıl önce
faq_keymap.md 12e43230c6 make custom_keycode_names.md a faq entry instead 5 yıl önce
feature_advanced_keycodes.md 54c58ea6de Add explicit id tags to externally linked headers 5 yıl önce
feature_audio.md d534c72a54 Added keycodes for swapping and unswapping the Control and OS keys (#6110) 5 yıl önce
feature_auto_shift.md e9c44e396d Smallish overhaul of Auto-Shift feature (#6067) 5 yıl önce
feature_backlight.md 54c58ea6de Add explicit id tags to externally linked headers 5 yıl önce
feature_bluetooth.md 908aede957 Update feature_bluetooth.md (#7193) 5 yıl önce
feature_bootmagic.md 54c58ea6de Add explicit id tags to externally linked headers 5 yıl önce
feature_combo.md 57540af102 Change "yu" to "you" in combo docs (#6510) 5 yıl önce
feature_command.md a2e91ebec9 Update IS_COMMAND definitions to use MOD_MASK_SHIFT (#6348) 6 yıl önce
feature_debounce_type.md 872744f5ab Update debounce docs (#7355) 5 yıl önce
feature_dip_switch.md dab4967f1b Add Dip Switch as a core feature (#6140) 5 yıl önce
feature_dynamic_macros.md 542cb0a8ce [Core] Convert Dynamic Macro to a Core Feature (#5948) 5 yıl önce
feature_encoders.md 26eef35f07 2020 February 29 Breaking Changes Update (#8064) 5 yıl önce
feature_grave_esc.md 3510d8dc8d Document an annoyance with Grave Escape and macOS Terminal (#5483) 6 yıl önce
feature_haptic_feedback.md f275ffbdfc Minor grammar and filename fixes in docs (#7559) 5 yıl önce
feature_hd44780.md b23f6011c3 Remove build option firmware size impacts (#6947) 5 yıl önce
feature_key_lock.md 54c58ea6de Add explicit id tags to externally linked headers 5 yıl önce
feature_layouts.md 40e67a3074 Add a mechanism for force building a particular community layout (#5027) 6 yıl önce
feature_leader_key.md 54c58ea6de Add explicit id tags to externally linked headers 5 yıl önce
feature_led_matrix.md 24df54b807 Add documentation for led matrix 6 yıl önce
feature_macros.md 444fd3b1cc Add support for delays in send_string. (#8244) 5 yıl önce
feature_mouse_keys.md 4856552f8b Update mouse keys docs (#5653) 6 yıl önce
feature_oled_driver.md 9456832a3b Fix out of bound OLED font access (#8145) 5 yıl önce
feature_pointing_device.md af37bb2f78 Fix some of the more obvious typos 7 yıl önce
feature_ps2_mouse.md c73d6f6ac8 [Docs] Removed dead link (#6922) 5 yıl önce
feature_rgb_matrix.md a1452db98a Configuration values for starting HSV and speed (#7740) 5 yıl önce
feature_rgblight.md f9521ffa21 Add shift-to-invert to remaining directional RGB_* keycode pairs (#7484) 5 yıl önce
feature_space_cadet.md d16db69367 Added mod carry over from press to release. (#5866) 6 yıl önce
feature_split_keyboard.md 307be48de9 Reduce SPLIT_USB_TIMEOUT by 500ms (#7637) 5 yıl önce
feature_stenography.md c0baf2a964 Improve state/chord handling and clean up namespace 7 yıl önce
feature_swap_hands.md fd085837e1 fix swap_hands keycodes in documentation (#3588) 6 yıl önce
feature_tap_dance.md 54c58ea6de Add explicit id tags to externally linked headers 5 yıl önce
feature_terminal.md b23f6011c3 Remove build option firmware size impacts (#6947) 5 yıl önce
feature_thermal_printer.md 4c675a83ba Format keycode tables 7 yıl önce
feature_unicode.md bb8d4b4d23 `send_unicode_string()`: Add support for code points > 0xFFFF (#8236) 5 yıl önce
feature_userspace.md 5a6737a778 Send string keycode tweaks (#7471) 5 yıl önce
feature_velocikey.md c1c5922aae Velocikey: Match RGB animation speed to typing speed (#3754) 6 yıl önce
flashing.md 3c98854044 update flashing.md 5 yıl önce
flashing_bootloadhid.md 235da6973d Install bootloadHid as part of qmk_install (#7463) 5 yıl önce
fuse.txt ca01d94005 convert docs to lowercase and underscores 8 yıl önce
getting_started_getting_help.md a701c15d87 Rework the newbs guide around the qmk cli 5 yıl önce
getting_started_introduction.md 09c7304bd9 [Docs] update git command and directory name of documents (#7619) 5 yıl önce
getting_started_make_guide.md 6e710426a4 Add docs for 'CUSTOM_MATRIX = lite' (#7906) 5 yıl önce
getting_started_vagrant.md dfdd9e821b [Docs] Update getting_started_vagrant.md (#7203) 5 yıl önce
hand_wire.md bc31ebd0c4 Hand Wire guide tidying, part 2 5 yıl önce
hardware_avr.md f87908228a Remove apostrophe from various abbreviations' plural forms (#7050) 5 yıl önce
hardware_drivers.md d13ada1162 Add customisable EEPROM driver selection (#7274) 5 yıl önce
hardware_keyboard_guidelines.md de386e5972 Fixed typos in documentation (#6871) 5 yıl önce
how_a_matrix_works.md a95a314f78 refactor How a Matrix Works doc 5 yıl önce
how_keyboards_work.md d5316e9714 Update URL for `60-keyboard.hwdb` (#7185) 5 yıl önce
i2c_driver.md e6a6b1f122 [Docs] Update i2c_driver.md (#6665) 5 yıl önce
index.html 8d8d61b3c5 limit the TOC to H1 and H2 5 yıl önce
internals_defines.md ae7284edb8 rename api docs to internals 7 yıl önce
internals_gpio_control.md 403c139b34 [Docs] Add AVR and ARM examples to GPIO Commands (#6942) 5 yıl önce
internals_input_callback_reg.md ae7284edb8 rename api docs to internals 7 yıl önce
internals_midi_device.md ae7284edb8 rename api docs to internals 7 yıl önce
internals_midi_device_setup_process.md ae7284edb8 rename api docs to internals 7 yıl önce
internals_midi_util.md ae7284edb8 rename api docs to internals 7 yıl önce
internals_send_functions.md ae7284edb8 rename api docs to internals 7 yıl önce
internals_sysex_tools.md ae7284edb8 rename api docs to internals 7 yıl önce
isp_flashing_guide.md abd36de5ad [Docs] Update ISP Flashing guide (#8149) 5 yıl önce
keycodes.md 54c58ea6de Add explicit id tags to externally linked headers 5 yıl önce
keycodes_basic.md 606813b72d Remove obsolete note about media keys in MacOS (#6631) 5 yıl önce
keycodes_us_ansi_shifted.md 40de65eac4 Backslash-escape pipe character in keycode lists (#7157) 5 yıl önce
keymap.md 54c58ea6de Add explicit id tags to externally linked headers 5 yıl önce
mod_tap.md 9035c3497e break feature_advanced_keycodes.md up into multiple files 5 yıl önce
newbs.md 45e218ceec overhaul the newbs guide 5 yıl önce
newbs_building_firmware.md 54c58ea6de Add explicit id tags to externally linked headers 5 yıl önce
newbs_building_firmware_configurator.md d5f34c4810 Polish Configurator section 5 yıl önce
newbs_flashing.md 54c58ea6de Add explicit id tags to externally linked headers 5 yıl önce
newbs_getting_started.md 54c58ea6de Add explicit id tags to externally linked headers 5 yıl önce
newbs_git_best_practices.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) 5 yıl önce
newbs_git_resolving_merge_conflicts.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) 5 yıl önce
newbs_git_resynchronize_a_branch.md 26a823082b [Docs] Fix minor differences in docs/newbs_git_resynchronize_a_branch.md (#7728) 5 yıl önce
newbs_git_using_your_master_branch.md 54c58ea6de Add explicit id tags to externally linked headers 5 yıl önce
newbs_learn_more_resources.md 45e218ceec overhaul the newbs guide 5 yıl önce
newbs_testing_debugging.md 54c58ea6de Add explicit id tags to externally linked headers 5 yıl önce
one_shot_keys.md 9035c3497e break feature_advanced_keycodes.md up into multiple files 5 yıl önce
other_eclipse.md 54c58ea6de Add explicit id tags to externally linked headers 5 yıl önce
other_vscode.md e9ace14878 [Docs] Add VSCode guide to docs (#5124) 6 yıl önce
power.txt bb53635f33 Trim trailing whitespace 7 yıl önce
proton_c_conversion.md 1af31a0523 Update feature support for Proton C (#7596) 5 yıl önce
qmk.css ccc87421e7 Some more tweaks to make everything look nice 7 yıl önce
quantum_keycodes.md 54c58ea6de Add explicit id tags to externally linked headers 5 yıl önce
redirects.json d569f08771 Configuration system for CLI (#6708) 5 yıl önce
ref_functions.md 54c58ea6de Add explicit id tags to externally linked headers 5 yıl önce
reference_configurator_support.md d5f34c4810 Polish Configurator section 5 yıl önce
reference_glossary.md f87908228a Remove apostrophe from various abbreviations' plural forms (#7050) 5 yıl önce
reference_info_json.md bcb1815420 Add label to the info.json reference 6 yıl önce
sidebar.css 3bd65d2173 CSS updates: ul and pre elements 5 yıl önce
support.md cdb5c074d3 remove some unnecessary external links 5 yıl önce
sw.js 303f425c6b Fix up info boxes. 7 yıl önce
tap_hold.md 9035c3497e break feature_advanced_keycodes.md up into multiple files 5 yıl önce
translating.md 7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) 5 yıl önce
understanding_qmk.md f87908228a Remove apostrophe from various abbreviations' plural forms (#7050) 5 yıl önce
unit_testing.md 54c58ea6de Add explicit id tags to externally linked headers 5 yıl önce
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores 8 yıl önce
ws2812_driver.md f74c769a19 PWM DMA based RGB Underglow for STM32 (#7928) 5 yıl önce

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. 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:

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.