Arialdo Martini 98ed19045d [Docs] Combos example consistently uses A B keys (#19792) há 3 anos atrás
..
ChangeLog 22be5190ab Minor cleanup to breaking/checklist docs. (#19596) há 3 anos atrás
gitbook 4580d3a730 RGB improvements (#1684) há 9 anos atrás
internals 75544d9127 Move Doxygen docs to subdirectory (#16561) há 4 anos atrás
ja 99174edf0a [Docs] Remove broken link (#19321) há 3 anos atrás
zh-cn 4d33f356a6 Macro keycode name refactoring (#18958) há 3 anos atrás
.nojekyll 9e5676650e Use docsfy to replace gitbook há 8 anos atrás
CNAME 4d26137e2a Create CNAME há 8 anos atrás
README.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) há 5 anos atrás
_langs.md 1c1e6fa47d Remove stale docs translations (#15737) há 4 anos atrás
_summary.md 08805cada0 Stub next develop dates há 3 anos atrás
adc_driver.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) há 5 anos atrás
api_development_environment.md 99850aabca Add API documentation há 6 anos atrás
api_development_overview.md 99850aabca Add API documentation há 6 anos atrás
api_docs.md 9e78e65a56 2022 Nov 26 changelog. (#19164) há 3 anos atrás
api_overview.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) há 5 anos atrás
arm_debugging.md 52c18ef026 [Docs] fix docs (#7642) há 6 anos atrás
audio_driver.md 19145704e4 [Core] Adjust PWM hardware audio driver for RP2040 (#17723) há 3 anos atrás
breaking_changes.md 22be5190ab Minor cleanup to breaking/checklist docs. (#19596) há 3 anos atrás
breaking_changes_history.md 08805cada0 Stub next develop dates há 3 anos atrás
breaking_changes_instructions.md fced377ac0 2020 May 30 Breaking Changes Update (#9215) há 6 anos atrás
chibios_upgrade_instructions.md 691668340c Add `qmk mass-compile`, which intends to supercede `qmk multibuild` whilst providing support for filtering as per data-driven definitions. (#18971) há 3 anos atrás
cli.md fcf150bd82 Streamline the macos install process há 6 anos atrás
cli_commands.md 959f4cbb62 docs: some typos (#18582) há 3 anos atrás
cli_configuration.md e4823aadec Fix capitalisation of "GitHub" (#9184) há 6 anos atrás
cli_development.md 959f4cbb62 docs: some typos (#18582) há 3 anos atrás
cli_tab_complete.md ee26d3e77f Add Zsh note for tab complete (#17226) há 4 anos atrás
coding_conventions_c.md 959f4cbb62 docs: some typos (#18582) há 3 anos atrás
coding_conventions_python.md 959f4cbb62 docs: some typos (#18582) há 3 anos atrás
compatible_microcontrollers.md ac5e6b6a3b Tentative Teensy 3.5 support (#14420) há 4 anos atrás
config_options.md 5dabc1b387 Merge remote-tracking branch 'origin/master' into develop há 3 anos atrás
configurator_architecture.md 9a0118c603 Architecture documentation for Configurator and API (#13935) há 5 anos atrás
configurator_default_keymaps.md 4d33f356a6 Macro keycode name refactoring (#18958) há 3 anos atrás
configurator_diagram.drawio 9a0118c603 Architecture documentation for Configurator and API (#13935) há 5 anos atrás
configurator_diagram.svg 9a0118c603 Architecture documentation for Configurator and API (#13935) há 5 anos atrás
configurator_step_by_step.md f6a7f4d4ac update the Chinese translation based on the latest English version (#14924) há 4 anos atrás
configurator_troubleshooting.md d5f34c4810 Polish Configurator section há 6 anos atrás
contributing.md 22be5190ab Minor cleanup to breaking/checklist docs. (#19596) há 3 anos atrás
custom_matrix.md 8224f62806 Make debounce() signal changes in the cooked matrix as return value (#17554) há 4 anos atrás
custom_quantum_functions.md 2c516fab29 [Docs] Extract 'Layer Change Code' and EEPROM (#18174) há 3 anos atrás
data_driven_config.md 479d8de622 Format DD mappings and schemas (#18924) há 3 anos atrás
documentation_best_practices.md 995464cb9c [Docs] fix file path (#9540) há 6 anos atrás
documentation_templates.md b756c53c7b [Docs] Touch up documentation templates & porting keyboard docs (#19573) há 3 anos atrás
driver_installation_zadig.md 01f31bf28e [Docs] RESET -> QK_BOOT (#18365) há 3 anos atrás
easy_maker.md f6a7f4d4ac update the Chinese translation based on the latest English version (#14924) há 4 anos atrás
eeprom_driver.md 5846b40f74 RP2040 emulated EEPROM. (#17519) há 4 anos atrás
faq_build.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) há 5 anos atrás
faq_debug.md 18dc851e37 Remove legacy Debug keycode (#18769) há 3 anos atrás
faq_general.md d6701b3ac7 Fix typos and reword some sentences in FAQs (#11546) há 5 anos atrás
faq_keymap.md d241e80533 Keymap FAQ updates (#17130) há 4 anos atrás
faq_misc.md 01f31bf28e [Docs] RESET -> QK_BOOT (#18365) há 3 anos atrás
feature_advanced_keycodes.md 2c516fab29 [Docs] Extract 'Layer Change Code' and EEPROM (#18174) há 3 anos atrás
feature_audio.md 69fa02c37d Align audio keycode names (#18962) há 3 anos atrás
feature_auto_shift.md 22be7e79ac Normalise Auto Shift keycodes (#18892) há 3 anos atrás
feature_autocorrect.md 2c878b1b16 Clean up `qmk generate-autocorrect-data` (#19710) há 3 anos atrás
feature_backlight.md 219afaba42 Reworked backlight keycodes. (#18961) há 3 anos atrás
feature_bluetooth.md d810878d5e Normalise output selection (Bluetooth) keycodes (#19004) há 3 anos atrás
feature_bootmagic.md 9aaf4a5a9b Add split keyboard example for Bootmagic Lite (#16349) há 4 anos atrás
feature_caps_word.md a80b886751 Deprecate `CAPS_WORD`/`CAPSWRD` for `CW_TOGG` (#18834) há 3 anos atrás
feature_combo.md 98ed19045d [Docs] Combos example consistently uses A B keys (#19792) há 3 anos atrás
feature_command.md a03aa301de Remove Full Bootmagic (#13846) há 5 anos atrás
feature_converters.md a42ab90220 Add Bonsai C4 as a platform board file (#18901) há 3 anos atrás
feature_debounce_type.md 25713dc222 Add sym_defer_pr debouncer type (#14948) há 4 anos atrás
feature_digitizer.md 6cc9513ab0 Digitizer feature improvements (#19034) há 3 anos atrás
feature_dip_switch.md 9d1c98c891 Added right vs left specific pin assignments for dip switch (#13074) há 5 anos atrás
feature_dynamic_macros.md fe18df9d41 Normalise Dynamic Macro keycodes (#18939) há 3 anos atrás
feature_eeprom.md 7407347be1 Remove rgblight_list.h (#18878) há 3 anos atrás
feature_encoders.md a781672ce7 docs: add a note about reflashing both halves for encoder resolution (#19162) há 3 anos atrás
feature_grave_esc.md b45a037c7e Rename some Quantum keycodes (#15968) há 4 anos atrás
feature_haptic_feedback.md e4d2ba9a4d Align haptic feedback keycode names (#18964) há 3 anos atrás
feature_hd44780.md 9ee2effe8e HD44780 driver rework (#16370) há 4 anos atrás
feature_joystick.md 917d93e968 [Docs] Fix `JOYSTICK_AXIS_COUNT` name in docs (#19605) há 3 anos atrás
feature_key_lock.md eeb3f9c043 Merge remote-tracking branch 'origin/master' into develop há 3 anos atrás
feature_key_overrides.md 1d34f380eb Deprecate `KEY_OVERRIDE_*` keycodes for `KO_*` (#18843) há 3 anos atrás
feature_layers.md 2bff00e1ba Small doc changes (#19601) há 3 anos atrás
feature_layouts.md b56282756b [Docs] Clean up some code block languages (#14434) há 5 anos atrás
feature_leader_key.md 737e6bf027 Highlight inclusion of extern macro (#19614) há 3 anos atrás
feature_led_indicators.md cbe1c22d46 quantum: led: split out led_update_ports() for customization of led behaviour (#14452) há 3 anos atrás
feature_led_matrix.md b56ffc8920 docs: Fix IS31FL3743A driver name (#19518) há 3 anos atrás
feature_macros.md 4d33f356a6 Macro keycode name refactoring (#18958) há 3 anos atrás
feature_midi.md a7febfbb62 changed the undefined ON and OFF parameters to thedefined constant (#19772) há 3 anos atrás
feature_mouse_keys.md 2a61bfc27d add "inertia" mode for mouse keys (#18774) há 3 anos atrás
feature_oled_driver.md a5c2eea6c1 Update OLED doc (#19213) há 3 anos atrás
feature_pointing_device.md fe652e6247 Fix references to `mouse_report_t` (which doesnt exist) (#19107) há 3 anos atrás
feature_programmable_button.md 6bbe8b6edd Normalise Joystick and Programmable Button keycodes (#18832) há 3 anos atrás
feature_ps2_mouse.md 0237ff0c62 [Core] Rework PS/2 driver selection (#17892) há 4 anos atrás
feature_rawhid.md b56282756b [Docs] Clean up some code block languages (#14434) há 5 anos atrás
feature_rgb_matrix.md 204ba02765 Use consistent highlight format (#19619) há 3 anos atrás
feature_rgblight.md 11ae141835 Fix description for selectively disabling animations (#19374) há 3 anos atrás
feature_secure.md ec2414c074 Deprecate `SECURE_*` keycodes for `QK_SECURE_*` (#18847) há 3 anos atrás
feature_send_string.md 3ecb0a80af Feature-ify Send String (#17275) há 4 anos atrás
feature_sequencer.md 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) há 5 anos atrás
feature_space_cadet.md 002b58f0e4 Normalise Space Cadet keycodes (#18864) há 3 anos atrás
feature_split_keyboard.md 87c4152738 Update handedness by define examples (#19687) há 3 anos atrás
feature_st7565.md 37fba09021 ST7565 invert (#13237) há 5 anos atrás
feature_stenography.md 95c1cc425e Rename postprocess_steno_user → post_process_steno_user (#17823) há 4 anos atrás
feature_swap_hands.md 8d5eacb7dd Add support for encoder mapping. (#13286) há 4 anos atrás
feature_tap_dance.md 99174edf0a [Docs] Remove broken link (#19321) há 3 anos atrás
feature_unicode.md 943aae85d5 Fixes unicode_map declaration example (#19450) há 3 anos atrás
feature_userspace.md 40bc5a8192 Enable CLI flashing via mdloader (#14729) há 4 anos atrás
feature_velocikey.md 74484e21af Deprecate `VLK_TOG` for `VK_TOGG` (#18807) há 3 anos atrás
feature_wpm.md 0391801267 Fixes potential wpm sampling overflow, along with code comment fixes (#15277) há 4 anos atrás
flash_driver.md 71c0b97bce Added external spi flash driver. (#15419) há 4 anos atrás
flashing.md 01f31bf28e [Docs] RESET -> QK_BOOT (#18365) há 3 anos atrás
flashing_bootloadhid.md 01f31bf28e [Docs] RESET -> QK_BOOT (#18365) há 3 anos atrás
fuse.txt 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) há 5 anos atrás
getting_started_docker.md b56282756b [Docs] Clean up some code block languages (#14434) há 5 anos atrás
getting_started_github.md b2a186cf92 Purge uGFX. (#14720) há 4 anos atrás
getting_started_introduction.md 09c7304bd9 [Docs] update git command and directory name of documents (#7619) há 6 anos atrás
getting_started_make_guide.md 36d123e9c5 Add support for deferred executors. (#14859) há 4 anos atrás
getting_started_vagrant.md b56282756b [Docs] Clean up some code block languages (#14434) há 5 anos atrás
gpio_control.md 75544d9127 Move Doxygen docs to subdirectory (#16561) há 4 anos atrás
hand_wire.md fc7e9efd21 Improve importer workflow (#17707) há 4 anos atrás
hardware_drivers.md b2a186cf92 Purge uGFX. (#14720) há 4 anos atrás
hardware_keyboard_guidelines.md 2ae215514a Add docs to cover recent LAYOUT_all lint checks (#19393) há 3 anos atrás
how_a_matrix_works.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) há 5 anos atrás
how_keyboards_work.md b85c224b7c docs: reflect systemd's change in language (#17322) há 4 anos atrás
i2c_driver.md 81be7bb7b5 Fix i2c driver doc: Incorrect name (#16898) há 4 anos atrás
index.html 94755308e0 Fix anchors with <code> in table of content (#15169) há 4 anos atrás
isp_flashing_guide.md dde4120a1e ISP flashing guide: add instructions for flashing STM32duino bootloader (#16568) há 4 anos atrás
keycodes.md 690eb4a453 Fix RWIN typo within keycode list (#19155) há 3 anos atrás
keycodes_basic.md a26f1ddafa Chromeos keycodes (#18212) há 3 anos atrás
keycodes_magic.md 871eeae4ea PoC: Swap Escape and Caps (#16336) há 4 anos atrás
keycodes_us_ansi_shifted.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) há 4 anos atrás
keymap.md 4b2d71de52 Remove legacy international keycodes (#18588) há 3 anos atrás
mod_tap.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) há 4 anos atrás
newbs.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) há 5 anos atrás
newbs_building_firmware.md 51f2d27321 Fix typo (#18526) há 3 anos atrás
newbs_building_firmware_configurator.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) há 5 anos atrás
newbs_building_firmware_workflow.md 64acbcb42a [Docs] Building with GitHub Userspace (#16271) há 4 anos atrás
newbs_flashing.md 4e35697e1a Add note about qmk doctor in newbs_flashing.md (#15688) há 4 anos atrás
newbs_getting_started.md 8fa7b62011 Attempt to discourage manual MSYS install for new users (#17556) há 4 anos atrás
newbs_git_best_practices.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) há 6 anos atrás
newbs_git_resolving_merge_conflicts.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) há 6 anos atrás
newbs_git_resynchronize_a_branch.md b56282756b [Docs] Clean up some code block languages (#14434) há 5 anos atrás
newbs_git_using_your_master_branch.md 54c58ea6de Add explicit id tags to externally linked headers há 6 anos atrás
newbs_learn_more_resources.md 70c6b183df [Docs] Refactor code examples (#18003) há 4 anos atrás
newbs_testing_debugging.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) há 5 anos atrás
one_shot_keys.md 9ddb0165a4 fix typo (#19189) há 3 anos atrás
other_eclipse.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) há 4 anos atrás
other_vscode.md 5f72d54299 Update other_vscode.md (#17317) há 4 anos atrás
platformdev_blackpill_f4x1.md e5b36e2c3f Docs: typo fixes in platformdev_blackpill_f4x1.md (#19635) há 3 anos atrás
platformdev_chibios_earlyinit.md 01f31bf28e [Docs] RESET -> QK_BOOT (#18365) há 3 anos atrás
platformdev_proton_c.md 345e19f691 Add converter docs (#17593) há 4 anos atrás
platformdev_rp2040.md 19145704e4 [Core] Adjust PWM hardware audio driver for RP2040 (#17723) há 3 anos atrás
platformdev_selecting_arm_mcu.md 3afd2d81b8 Add documentation for selecting an Arm MCU (#9046) há 6 anos atrás
porting_your_keyboard_to_qmk.md b756c53c7b [Docs] Touch up documentation templates & porting keyboard docs (#19573) há 3 anos atrás
power.txt bb53635f33 Trim trailing whitespace há 8 anos atrás
pr_checklist.md 22be5190ab Minor cleanup to breaking/checklist docs. (#19596) há 3 anos atrás
qmk.css ccc87421e7 Some more tweaks to make everything look nice há 8 anos atrás
qmk_custom_dark.css 4e8166750b Small tweaks to docs to make them more user friendly (#11518) há 5 anos atrás
qmk_custom_light.css 4e8166750b Small tweaks to docs to make them more user friendly (#11518) há 5 anos atrás
quantum_keycodes.md a6f3194397 Add ability to enter bootloader mode from `QK_MAKE` (#17745) há 4 anos atrás
quantum_painter.md 9daf77b593 Add raw output option for QGF/QFF files. (#18998) há 3 anos atrás
quantum_painter_qff.md 1f2b1dedcc Quantum Painter (#10174) há 4 anos atrás
quantum_painter_qgf.md 1f2b1dedcc Quantum Painter (#10174) há 4 anos atrás
quantum_painter_rle.md 1f2b1dedcc Quantum Painter (#10174) há 4 anos atrás
redirects.json d569f08771 Configuration system for CLI (#6708) há 7 anos atrás
ref_functions.md c347e732be Remove legacy EEPROM clear keycodes (#18782) há 3 anos atrás
reference_configurator_support.md f529580860 Basic keycode overhaul (#14726) há 4 anos atrás
reference_glossary.md 014aa0661e Fix Space Cadet md link (#14300) há 5 anos atrás
reference_info_json.md 4a0aa9ada2 Fix headers in info.json reference (#19202) há 3 anos atrás
reference_keymap_extras.md 4a8bd7b9a5 Rename keymap_extras headers for consistency (#16939) há 4 anos atrás
serial_driver.md 40aa9c8745 spelling fix (#18831) há 3 anos atrás
spi_driver.md 0e59827023 Merge remote-tracking branch 'upstream/master' into develop há 5 anos atrás
squeezing_avr.md fb6e821541 Add Elite-Pi converter (#18236) há 4 anos atrás
support.md e4823aadec Fix capitalisation of "GitHub" (#9184) há 6 anos atrás
sw.js 303f425c6b Fix up info boxes. há 8 anos atrás
syllabus.md f4966a19d6 [Docs] Squeezing space out of AVR (#15243) há 4 anos atrás
tap_hold.md fd4c3f46fb Align dynamic tapping term keycode names (#18963) há 3 anos atrás
translating.md 7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) há 6 anos atrás
uart_driver.md 04b51e381e Update UART driver API (#14839) há 4 anos atrás
understanding_qmk.md 419a7944a4 Update understanding_qmk.md (#19664) há 3 anos atrás
unit_testing.md 1c0347b8b8 Remove SERIAL_LINK feature (#14727) há 4 anos atrás
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores há 9 anos atrás
ws2812_driver.md 27dec8d16d [Core] Allow custom timings for WS2812 PIO driver (#18006) há 3 anos atrás

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

?> **Basic** [QMK Configurator](newbs_building_firmware_configurator.md)
User friendly graphical interfaces, no programming knowledge required. ?> **Advanced** [Use The Source](newbs.md)
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.