Joel Challis 19dbcf3814 Document 'make all:<name>' (#8439) 6 jaren geleden
..
ChangeLog 26eef35f07 2020 February 29 Breaking Changes Update (#8064) 6 jaren geleden
de 54c58ea6de Add explicit id tags to externally linked headers 6 jaren geleden
es 54c58ea6de Add explicit id tags to externally linked headers 6 jaren geleden
fr-fr 54c58ea6de Add explicit id tags to externally linked headers 6 jaren geleden
gitbook 4580d3a730 RGB improvements (#1684) 9 jaren geleden
he-il 54c58ea6de Add explicit id tags to externally linked headers 6 jaren geleden
ja 2a05d433c9 Rename qmk json-keymap to qmk json2c (#8372) 6 jaren geleden
pt-br 54c58ea6de Add explicit id tags to externally linked headers 6 jaren geleden
ru-ru 54c58ea6de Add explicit id tags to externally linked headers 6 jaren geleden
zh-cn 54c58ea6de Add explicit id tags to externally linked headers 6 jaren geleden
.nojekyll 9e5676650e Use docsfy to replace gitbook 8 jaren geleden
CNAME 4d26137e2a Create CNAME 8 jaren geleden
README.md 961477c791 make sure all our redirects are in order 6 jaren geleden
_langs.md 10e8ed7430 [Docs] add README translation in portuguese (#7016) 6 jaren geleden
_summary.md dc68418660 Fix some broken links in the docs (#8394) 6 jaren geleden
adc_driver.md 5ac6fe1888 Add ADC support for STM32F3 and STM32F0 devices (#7681) 6 jaren geleden
api_development_environment.md 99850aabca Add API documentation 6 jaren geleden
api_development_overview.md 99850aabca Add API documentation 6 jaren geleden
api_docs.md 99850aabca Add API documentation 6 jaren geleden
api_overview.md 99850aabca Add API documentation 6 jaren geleden
arm_debugging.md 52c18ef026 [Docs] fix docs (#7642) 6 jaren geleden
breaking_changes.md f513a9193c Fix the Breaking Changes doc again 6 jaren geleden
breaking_changes_instructions.md 72d7661b30 suggestions by skullydazed 6 jaren geleden
cli.md b272c035ba [Docs] Random Fixes (#8340) 6 jaren geleden
cli_commands.md 19dbcf3814 Document 'make all:<name>' (#8439) 6 jaren geleden
cli_configuration.md dc68418660 Fix some broken links in the docs (#8394) 6 jaren geleden
cli_development.md f7bdc54c69 Add flake8 to our test suite and fix all errors (#7379) 6 jaren geleden
coding_conventions_c.md f275ffbdfc Minor grammar and filename fixes in docs (#7559) 6 jaren geleden
coding_conventions_python.md 58d27cf404 Add a note explaining how to run tests 6 jaren geleden
compatible_microcontrollers.md 5414ff709f [Doc] Tidy up compatible MCUs docs (#7295) 6 jaren geleden
config_options.md 2ffb08843b Feature: RGBLight layers (#7768) 6 jaren geleden
configurator_step_by_step.md d5f34c4810 Polish Configurator section 6 jaren geleden
configurator_troubleshooting.md d5f34c4810 Polish Configurator section 6 jaren geleden
contributing.md 54c58ea6de Add explicit id tags to externally linked headers 6 jaren geleden
custom_matrix.md 6e710426a4 Add docs for 'CUSTOM_MATRIX = lite' (#7906) 6 jaren geleden
custom_quantum_functions.md 54c58ea6de Add explicit id tags to externally linked headers 6 jaren geleden
documentation_best_practices.md 303f425c6b Fix up info boxes. 8 jaren geleden
documentation_templates.md 54c58ea6de Add explicit id tags to externally linked headers 6 jaren geleden
driver_installation_zadig.md 80ded60cad Add a short explanation to Zadig the troubleshooting section (#7110) 6 jaren geleden
eeprom_driver.md f2f2afe13b Add support for STM32L0/L1 onboard EEPROM. (#8002) 6 jaren geleden
faq_build.md a52e55ec09 [Docs] Update macOS related issues in docs (#7744) 6 jaren geleden
faq_debug.md 770a4ee729 [Docs] Remove some outdated FAQ items (#7607) 6 jaren geleden
faq_general.md a701c15d87 Rework the newbs guide around the qmk cli 6 jaren geleden
faq_keymap.md 12e43230c6 make custom_keycode_names.md a faq entry instead 6 jaren geleden
feature_advanced_keycodes.md 961477c791 make sure all our redirects are in order 6 jaren geleden
feature_audio.md d534c72a54 Added keycodes for swapping and unswapping the Control and OS keys (#6110) 7 jaren geleden
feature_auto_shift.md e9c44e396d Smallish overhaul of Auto-Shift feature (#6067) 6 jaren geleden
feature_backlight.md 54c58ea6de Add explicit id tags to externally linked headers 6 jaren geleden
feature_bluetooth.md 908aede957 Update feature_bluetooth.md (#7193) 6 jaren geleden
feature_bootmagic.md 54c58ea6de Add explicit id tags to externally linked headers 6 jaren geleden
feature_combo.md 57540af102 Change "yu" to "you" in combo docs (#6510) 7 jaren geleden
feature_command.md a2e91ebec9 Update IS_COMMAND definitions to use MOD_MASK_SHIFT (#6348) 7 jaren geleden
feature_debounce_type.md 872744f5ab Update debounce docs (#7355) 6 jaren geleden
feature_dip_switch.md dab4967f1b Add Dip Switch as a core feature (#6140) 7 jaren geleden
feature_dynamic_macros.md 542cb0a8ce [Core] Convert Dynamic Macro to a Core Feature (#5948) 6 jaren geleden
feature_encoders.md 26eef35f07 2020 February 29 Breaking Changes Update (#8064) 6 jaren geleden
feature_grave_esc.md 3510d8dc8d Document an annoyance with Grave Escape and macOS Terminal (#5483) 7 jaren geleden
feature_haptic_feedback.md f275ffbdfc Minor grammar and filename fixes in docs (#7559) 6 jaren geleden
feature_hd44780.md b23f6011c3 Remove build option firmware size impacts (#6947) 6 jaren geleden
feature_key_lock.md 54c58ea6de Add explicit id tags to externally linked headers 6 jaren geleden
feature_layouts.md 40e67a3074 Add a mechanism for force building a particular community layout (#5027) 7 jaren geleden
feature_leader_key.md 54c58ea6de Add explicit id tags to externally linked headers 6 jaren geleden
feature_led_matrix.md 24df54b807 Add documentation for led matrix 7 jaren geleden
feature_macros.md 444fd3b1cc Add support for delays in send_string. (#8244) 6 jaren geleden
feature_mouse_keys.md 3cd2a27ac0 Decouple mouse cursor and mouse wheel in accelerated mode (#6685) 6 jaren geleden
feature_oled_driver.md b5be96f8bb Adding OLED scroll setup functions (#8386) 6 jaren geleden
feature_pointing_device.md b272c035ba [Docs] Random Fixes (#8340) 6 jaren geleden
feature_ps2_mouse.md b272c035ba [Docs] Random Fixes (#8340) 6 jaren geleden
feature_rgb_matrix.md b272c035ba [Docs] Random Fixes (#8340) 6 jaren geleden
feature_rgblight.md 2ffb08843b Feature: RGBLight layers (#7768) 6 jaren geleden
feature_space_cadet.md d16db69367 Added mod carry over from press to release. (#5866) 7 jaren geleden
feature_split_keyboard.md 307be48de9 Reduce SPLIT_USB_TIMEOUT by 500ms (#7637) 6 jaren geleden
feature_stenography.md b272c035ba [Docs] Random Fixes (#8340) 6 jaren geleden
feature_swap_hands.md fd085837e1 fix swap_hands keycodes in documentation (#3588) 8 jaren geleden
feature_tap_dance.md 54c58ea6de Add explicit id tags to externally linked headers 6 jaren geleden
feature_terminal.md b23f6011c3 Remove build option firmware size impacts (#6947) 6 jaren geleden
feature_thermal_printer.md 4c675a83ba Format keycode tables 8 jaren geleden
feature_unicode.md bb8d4b4d23 `send_unicode_string()`: Add support for code points > 0xFFFF (#8236) 6 jaren geleden
feature_userspace.md 19dbcf3814 Document 'make all:<name>' (#8439) 6 jaren geleden
feature_velocikey.md c1c5922aae Velocikey: Match RGB animation speed to typing speed (#3754) 7 jaren geleden
flashing.md 3c98854044 update flashing.md 6 jaren geleden
flashing_bootloadhid.md 235da6973d Install bootloadHid as part of qmk_install (#7463) 6 jaren geleden
fuse.txt ca01d94005 convert docs to lowercase and underscores 9 jaren geleden
getting_started_github.md 9046107183 Restore getting_started_github.md doc 6 jaren geleden
getting_started_introduction.md 09c7304bd9 [Docs] update git command and directory name of documents (#7619) 6 jaren geleden
getting_started_make_guide.md 6e710426a4 Add docs for 'CUSTOM_MATRIX = lite' (#7906) 6 jaren geleden
getting_started_vagrant.md dfdd9e821b [Docs] Update getting_started_vagrant.md (#7203) 6 jaren geleden
hand_wire.md 961477c791 make sure all our redirects are in order 6 jaren geleden
hardware_avr.md f87908228a Remove apostrophe from various abbreviations' plural forms (#7050) 6 jaren geleden
hardware_drivers.md d13ada1162 Add customisable EEPROM driver selection (#7274) 6 jaren geleden
hardware_keyboard_guidelines.md de386e5972 Fixed typos in documentation (#6871) 6 jaren geleden
how_a_matrix_works.md a95a314f78 refactor How a Matrix Works doc 6 jaren geleden
how_keyboards_work.md d5316e9714 Update URL for `60-keyboard.hwdb` (#7185) 6 jaren geleden
i2c_driver.md b272c035ba [Docs] Random Fixes (#8340) 6 jaren geleden
index.html dc68418660 Fix some broken links in the docs (#8394) 6 jaren geleden
internals_defines.md ae7284edb8 rename api docs to internals 8 jaren geleden
internals_gpio_control.md b272c035ba [Docs] Random Fixes (#8340) 6 jaren geleden
internals_input_callback_reg.md ae7284edb8 rename api docs to internals 8 jaren geleden
internals_midi_device.md ae7284edb8 rename api docs to internals 8 jaren geleden
internals_midi_device_setup_process.md ae7284edb8 rename api docs to internals 8 jaren geleden
internals_midi_util.md ae7284edb8 rename api docs to internals 8 jaren geleden
internals_send_functions.md ae7284edb8 rename api docs to internals 8 jaren geleden
internals_sysex_tools.md ae7284edb8 rename api docs to internals 8 jaren geleden
isp_flashing_guide.md abd36de5ad [Docs] Update ISP Flashing guide (#8149) 6 jaren geleden
keycodes.md 2939751eb3 keycodes.md: hard-code section link id attributes 6 jaren geleden
keycodes_basic.md 606813b72d Remove obsolete note about media keys in MacOS (#6631) 6 jaren geleden
keycodes_us_ansi_shifted.md 40de65eac4 Backslash-escape pipe character in keycode lists (#7157) 6 jaren geleden
keymap.md 54c58ea6de Add explicit id tags to externally linked headers 6 jaren geleden
mod_tap.md 9035c3497e break feature_advanced_keycodes.md up into multiple files 6 jaren geleden
newbs.md 45e218ceec overhaul the newbs guide 6 jaren geleden
newbs_building_firmware.md 54c58ea6de Add explicit id tags to externally linked headers 6 jaren geleden
newbs_building_firmware_configurator.md d5f34c4810 Polish Configurator section 6 jaren geleden
newbs_flashing.md 54c58ea6de Add explicit id tags to externally linked headers 6 jaren geleden
newbs_getting_started.md 54c58ea6de Add explicit id tags to externally linked headers 6 jaren geleden
newbs_git_best_practices.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) 6 jaren geleden
newbs_git_resolving_merge_conflicts.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) 6 jaren geleden
newbs_git_resynchronize_a_branch.md 26a823082b [Docs] Fix minor differences in docs/newbs_git_resynchronize_a_branch.md (#7728) 6 jaren geleden
newbs_git_using_your_master_branch.md 54c58ea6de Add explicit id tags to externally linked headers 6 jaren geleden
newbs_learn_more_resources.md 45e218ceec overhaul the newbs guide 6 jaren geleden
newbs_testing_debugging.md 54c58ea6de Add explicit id tags to externally linked headers 6 jaren geleden
one_shot_keys.md 9035c3497e break feature_advanced_keycodes.md up into multiple files 6 jaren geleden
other_eclipse.md cde5237a88 fix two links on docs/other_eclipse.md (#8417) 6 jaren geleden
other_vscode.md e9ace14878 [Docs] Add VSCode guide to docs (#5124) 7 jaren geleden
power.txt bb53635f33 Trim trailing whitespace 8 jaren geleden
proton_c_conversion.md 1af31a0523 Update feature support for Proton C (#7596) 6 jaren geleden
qmk.css ccc87421e7 Some more tweaks to make everything look nice 8 jaren geleden
qmk_custom_dark.css 1b267d4840 Fix darkmode (#8393) 6 jaren geleden
qmk_custom_light.css 1b267d4840 Fix darkmode (#8393) 6 jaren geleden
quantum_keycodes.md 54c58ea6de Add explicit id tags to externally linked headers 6 jaren geleden
redirects.json d569f08771 Configuration system for CLI (#6708) 7 jaren geleden
ref_functions.md 54c58ea6de Add explicit id tags to externally linked headers 6 jaren geleden
reference_configurator_support.md d5f34c4810 Polish Configurator section 6 jaren geleden
reference_glossary.md f87908228a Remove apostrophe from various abbreviations' plural forms (#7050) 6 jaren geleden
reference_info_json.md bcb1815420 Add label to the info.json reference 7 jaren geleden
support.md 961477c791 make sure all our redirects are in order 6 jaren geleden
sw.js 303f425c6b Fix up info boxes. 8 jaren geleden
tap_hold.md 4e826ba61f Correct typo in tap_hold.md (#8326) 6 jaren geleden
translating.md 7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) 6 jaren geleden
understanding_qmk.md f87908228a Remove apostrophe from various abbreviations' plural forms (#7050) 6 jaren geleden
unit_testing.md 54c58ea6de Add explicit id tags to externally linked headers 6 jaren geleden
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores 9 jaren geleden
ws2812_driver.md f74c769a19 PWM DMA based RGB Underglow for STM32 (#7928) 6 jaren geleden

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.