James Young fced377ac0 2020 May 30 Breaking Changes Update (#9215) 6 years ago
..
ChangeLog fced377ac0 2020 May 30 Breaking Changes Update (#9215) 6 years ago
de e4823aadec Fix capitalisation of "GitHub" (#9184) 6 years ago
es e4823aadec Fix capitalisation of "GitHub" (#9184) 6 years ago
fr-fr e4823aadec Fix capitalisation of "GitHub" (#9184) 6 years ago
gitbook 4580d3a730 RGB improvements (#1684) 9 years ago
he-il e4823aadec Fix capitalisation of "GitHub" (#9184) 6 years ago
ja fced377ac0 2020 May 30 Breaking Changes Update (#9215) 6 years ago
pt-br e4823aadec Fix capitalisation of "GitHub" (#9184) 6 years ago
ru-ru e4823aadec Fix capitalisation of "GitHub" (#9184) 6 years ago
zh-cn fced377ac0 2020 May 30 Breaking Changes Update (#9215) 6 years ago
.nojekyll 9e5676650e Use docsfy to replace gitbook 8 years ago
CNAME 4d26137e2a Create CNAME 8 years ago
README.md 961477c791 make sure all our redirects are in order 6 years ago
_langs.md 10e8ed7430 [Docs] add README translation in portuguese (#7016) 6 years ago
_summary.md fced377ac0 2020 May 30 Breaking Changes Update (#9215) 6 years ago
adc_driver.md 567bfc97ac ARM - ADC cleanup (#8385) 6 years ago
api_development_environment.md 99850aabca Add API documentation 6 years ago
api_development_overview.md 99850aabca Add API documentation 6 years ago
api_docs.md 99850aabca Add API documentation 6 years ago
api_overview.md 99850aabca Add API documentation 6 years ago
arm_debugging.md 52c18ef026 [Docs] fix docs (#7642) 6 years ago
breaking_changes.md fced377ac0 2020 May 30 Breaking Changes Update (#9215) 6 years ago
breaking_changes_instructions.md fced377ac0 2020 May 30 Breaking Changes Update (#9215) 6 years ago
cli.md fcf150bd82 Streamline the macos install process 6 years ago
cli_commands.md 751316c344 [CLI] Add a subcommand for getting information about a keyboard (#8666) 6 years ago
cli_configuration.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 years ago
cli_development.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 years ago
coding_conventions_c.md f4b67cde8a Update C coding conventions to match .clang-format config for i… (#8717) 6 years ago
coding_conventions_python.md 66d94dc22a Move everything to Python 3.6 (#8835) 6 years ago
compatible_microcontrollers.md 5414ff709f [Doc] Tidy up compatible MCUs docs (#7295) 6 years ago
config_options.md a8a8bf0ff3 Allow expanding from 8 to 32 RGB Lighting Layers (#8941) 6 years ago
configurator_step_by_step.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 years ago
configurator_troubleshooting.md d5f34c4810 Polish Configurator section 6 years ago
contributing.md 54c58ea6de Add explicit id tags to externally linked headers 6 years ago
custom_matrix.md 6e710426a4 Add docs for 'CUSTOM_MATRIX = lite' (#7906) 6 years ago
custom_quantum_functions.md fced377ac0 2020 May 30 Breaking Changes Update (#9215) 6 years ago
documentation_best_practices.md 303f425c6b Fix up info boxes. 8 years ago
documentation_templates.md 54c58ea6de Add explicit id tags to externally linked headers 6 years ago
driver_installation_zadig.md 80ded60cad Add a short explanation to Zadig the troubleshooting section (#7110) 6 years ago
eeprom_driver.md 54b04d9665 Add SPI 25xx EEPROM support. (#8780) 6 years ago
faq_build.md fcf150bd82 Streamline the macos install process 6 years ago
faq_debug.md bc13dcd349 Remove Atmel FLIP from install scripts and documentation (#8822) 6 years ago
faq_general.md a701c15d87 Rework the newbs guide around the qmk cli 6 years ago
faq_keymap.md 12e43230c6 make custom_keycode_names.md a faq entry instead 6 years ago
feature_advanced_keycodes.md 370577e4ed Add *OPT aliases for *ALT keycodes and macros (#8714) 6 years ago
feature_audio.md d534c72a54 Added keycodes for swapping and unswapping the Control and OS keys (#6110) 7 years ago
feature_auto_shift.md e9c44e396d Smallish overhaul of Auto-Shift feature (#6067) 6 years ago
feature_backlight.md 54c58ea6de Add explicit id tags to externally linked headers 6 years ago
feature_bluetooth.md 908aede957 Update feature_bluetooth.md (#7193) 6 years ago
feature_bootmagic.md 789e199450 Add support for Bootmagic lite when using SPLIT_HAND_PIN (#8347) 6 years ago
feature_combo.md 57540af102 Change "yu" to "you" in combo docs (#6510) 7 years ago
feature_command.md a2e91ebec9 Update IS_COMMAND definitions to use MOD_MASK_SHIFT (#6348) 7 years ago
feature_debounce_type.md b8c3f4c60b quantum/debounce: Added sym_pk debounce algorithm (#8587) 6 years ago
feature_dip_switch.md dab4967f1b Add Dip Switch as a core feature (#6140) 7 years ago
feature_dynamic_macros.md 542cb0a8ce [Core] Convert Dynamic Macro to a Core Feature (#5948) 6 years ago
feature_encoders.md bafa35ff46 fix sample code indent in feature_encoders.md (#8883) 6 years ago
feature_grave_esc.md 3510d8dc8d Document an annoyance with Grave Escape and macOS Terminal (#5483) 7 years ago
feature_haptic_feedback.md f275ffbdfc Minor grammar and filename fixes in docs (#7559) 6 years ago
feature_hd44780.md d846660e00 fixed typo for clear lcd screen function in hd44780 docs (#9086) 6 years ago
feature_key_lock.md 54c58ea6de Add explicit id tags to externally linked headers 6 years ago
feature_layers.md 5df2424651 [Docs] Update layer documentation (#8371) 6 years ago
feature_layouts.md 40e67a3074 Add a mechanism for force building a particular community layout (#5027) 7 years ago
feature_leader_key.md 5df2424651 [Docs] Update layer documentation (#8371) 6 years ago
feature_led_matrix.md 24df54b807 Add documentation for led matrix 7 years ago
feature_macros.md 370577e4ed Add *OPT aliases for *ALT keycodes and macros (#8714) 6 years ago
feature_mouse_keys.md 3cd2a27ac0 Decouple mouse cursor and mouse wheel in accelerated mode (#6685) 6 years ago
feature_oled_driver.md b5be96f8bb Adding OLED scroll setup functions (#8386) 6 years ago
feature_pointing_device.md f66680d233 Fixed the indentation of the sample code in feature_pointing_device docs (#9177) 6 years ago
feature_ps2_mouse.md 07c75feba3 Add PS2_MOUSE_ROTATE to compensate for device orientation (#8650) 6 years ago
feature_rawhid.md d1df576ece Allow for overriding RAW endpoint usage page and ID. (#8834) 6 years ago
feature_rgb_matrix.md fced377ac0 2020 May 30 Breaking Changes Update (#9215) 6 years ago
feature_rgblight.md d0e0202b27 Add query functions for RGB Light and RGB Matrix (#8960) 6 years ago
feature_space_cadet.md d16db69367 Added mod carry over from press to release. (#5866) 7 years ago
feature_split_keyboard.md 6d84795bc1 Update ARM split keyboard docs (#9160) 6 years ago
feature_stenography.md b272c035ba [Docs] Random Fixes (#8340) 6 years ago
feature_swap_hands.md 805f5cb72b One shot support for swap hands (#8590) 6 years ago
feature_tap_dance.md 54c58ea6de Add explicit id tags to externally linked headers 6 years ago
feature_terminal.md b23f6011c3 Remove build option firmware size impacts (#6947) 6 years ago
feature_thermal_printer.md 4c675a83ba Format keycode tables 8 years ago
feature_unicode.md bdfdc506da Rename UC_OSX (and related constants) to UC_MAC (#8589) 6 years ago
feature_userspace.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 years ago
feature_velocikey.md c1c5922aae Velocikey: Match RGB animation speed to typing speed (#3754) 7 years ago
feature_wpm.md bfb2f8e0a8 Add Word Per Minute calculation feature (#8054) 6 years ago
flashing.md bc13dcd349 Remove Atmel FLIP from install scripts and documentation (#8822) 6 years ago
flashing_bootloadhid.md 235da6973d Install bootloadHid as part of qmk_install (#7463) 6 years ago
fuse.txt ca01d94005 convert docs to lowercase and underscores 9 years ago
getting_started_docker.md 0fbcb41c85 Reintegrate previous docker docs (#9084) 6 years ago
getting_started_github.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 years ago
getting_started_introduction.md 09c7304bd9 [Docs] update git command and directory name of documents (#7619) 6 years ago
getting_started_make_guide.md 6e710426a4 Add docs for 'CUSTOM_MATRIX = lite' (#7906) 6 years ago
getting_started_vagrant.md bc13dcd349 Remove Atmel FLIP from install scripts and documentation (#8822) 6 years ago
hand_wire.md 961477c791 make sure all our redirects are in order 6 years ago
hardware_avr.md f87908228a Remove apostrophe from various abbreviations' plural forms (#7050) 6 years ago
hardware_drivers.md d13ada1162 Add customisable EEPROM driver selection (#7274) 6 years ago
hardware_keyboard_guidelines.md dc98d44582 [Docs] added the description of the reading order of the rules.mk files. (#8566) 6 years ago
how_a_matrix_works.md a95a314f78 refactor How a Matrix Works doc 6 years ago
how_keyboards_work.md d5316e9714 Update URL for `60-keyboard.hwdb` (#7185) 6 years ago
i2c_driver.md b272c035ba [Docs] Random Fixes (#8340) 6 years ago
index.html e182a38e7c Add redirect for old getting started links (#8987) 6 years ago
internals_defines.md ae7284edb8 rename api docs to internals 8 years ago
internals_gpio_control.md d26a14c169 add 'togglePin' convenience function (#8734) 6 years ago
internals_input_callback_reg.md ae7284edb8 rename api docs to internals 8 years ago
internals_midi_device.md ae7284edb8 rename api docs to internals 8 years ago
internals_midi_device_setup_process.md ae7284edb8 rename api docs to internals 8 years ago
internals_midi_util.md ae7284edb8 rename api docs to internals 8 years ago
internals_send_functions.md ae7284edb8 rename api docs to internals 8 years ago
internals_sysex_tools.md ae7284edb8 rename api docs to internals 8 years ago
isp_flashing_guide.md f66850bfd0 Improve stock bootloader list (#9067) 6 years ago
keycodes.md 805f5cb72b One shot support for swap hands (#8590) 6 years ago
keycodes_basic.md 370577e4ed Add *OPT aliases for *ALT keycodes and macros (#8714) 6 years ago
keycodes_us_ansi_shifted.md 40de65eac4 Backslash-escape pipe character in keycode lists (#7157) 6 years ago
keymap.md 142ebaea46 [Docs] Clarify layer transparency keymap.md (#9081) 6 years ago
mod_tap.md 370577e4ed Add *OPT aliases for *ALT keycodes and macros (#8714) 6 years ago
newbs.md 45e218ceec overhaul the newbs guide 6 years ago
newbs_building_firmware.md 54c58ea6de Add explicit id tags to externally linked headers 6 years ago
newbs_building_firmware_configurator.md d5f34c4810 Polish Configurator section 6 years ago
newbs_flashing.md 9c8f61dfa0 [Docs] newbs_flashing.md: place bootloader instructions before Toolbox intro (#9077) 6 years ago
newbs_getting_started.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 years ago
newbs_git_best_practices.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) 6 years ago
newbs_git_resolving_merge_conflicts.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) 6 years ago
newbs_git_resynchronize_a_branch.md 26a823082b [Docs] Fix minor differences in docs/newbs_git_resynchronize_a_branch.md (#7728) 6 years ago
newbs_git_using_your_master_branch.md 54c58ea6de Add explicit id tags to externally linked headers 6 years ago
newbs_learn_more_resources.md 45e218ceec overhaul the newbs guide 6 years ago
newbs_testing_debugging.md 54c58ea6de Add explicit id tags to externally linked headers 6 years ago
one_shot_keys.md 9035c3497e break feature_advanced_keycodes.md up into multiple files 6 years ago
other_eclipse.md cde5237a88 fix two links on docs/other_eclipse.md (#8417) 6 years ago
other_vscode.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 years ago
platformdev_chibios_earlyinit.md 05e9ff6554 Add support for hardware and board initialisation overrides. (#8330) 6 years ago
power.txt bb53635f33 Trim trailing whitespace 8 years ago
proton_c_conversion.md 6d84795bc1 Update ARM split keyboard docs (#9160) 6 years ago
qmk.css ccc87421e7 Some more tweaks to make everything look nice 8 years ago
qmk_custom_dark.css 1b267d4840 Fix darkmode (#8393) 6 years ago
qmk_custom_light.css 1b267d4840 Fix darkmode (#8393) 6 years ago
quantum_keycodes.md 54c58ea6de Add explicit id tags to externally linked headers 6 years ago
redirects.json d569f08771 Configuration system for CLI (#6708) 6 years ago
ref_functions.md 750179e111 Fix a couple of typos that were causing confusion (#8767) 6 years ago
reference_configurator_support.md d5f34c4810 Polish Configurator section 6 years ago
reference_glossary.md bc13dcd349 Remove Atmel FLIP from install scripts and documentation (#8822) 6 years ago
reference_info_json.md bcb1815420 Add label to the info.json reference 7 years ago
reference_keymap_extras.md 00c1401d3c Documentation for keymap_extras (#9194) 6 years ago
serial_driver.md 6d84795bc1 Update ARM split keyboard docs (#9160) 6 years ago
spi_driver.md b17482c3fd Add SPI master for ChibiOS/ARM. (#8779) 6 years ago
support.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 years ago
sw.js 303f425c6b Fix up info boxes. 8 years ago
syllabus.md 9b70e53508 [Docs] Fixed minor typos (#8860) 6 years ago
tap_hold.md fced377ac0 2020 May 30 Breaking Changes Update (#9215) 6 years ago
translating.md 7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) 6 years ago
understanding_qmk.md 5117dff6a2 Add Post Processing to process_record (#4892) 6 years ago
unit_testing.md e02a3c559d Edit Unit Testing Documentation (#8961) 6 years ago
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores 9 years ago
ws2812_driver.md f74c769a19 PWM DMA based RGB Underglow for STM32 (#7928) 6 years ago

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.