jpe230 102f22f7e9 [Core] Quantum Painter - LVGL Integration (#18499) 3 лет назад
..
ChangeLog 9e78e65a56 2022 Nov 26 changelog. (#19164) 3 лет назад
gitbook 4580d3a730 RGB improvements (#1684) 9 лет назад
internals 75544d9127 Move Doxygen docs to subdirectory (#16561) 4 лет назад
ja 53423f0369 KC_GESC -> QK_GESC for cn and ja Docs (#19024) 3 лет назад
zh-cn 53423f0369 KC_GESC -> QK_GESC for cn and ja Docs (#19024) 3 лет назад
.nojekyll 9e5676650e Use docsfy to replace gitbook 8 лет назад
CNAME 4d26137e2a Create CNAME 8 лет назад
README.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 лет назад
_langs.md 1c1e6fa47d Remove stale docs translations (#15737) 4 лет назад
_summary.md 102f22f7e9 [Core] Quantum Painter - LVGL Integration (#18499) 3 лет назад
adc_driver.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 5 лет назад
api_development_environment.md 99850aabca Add API documentation 6 лет назад
api_development_overview.md 99850aabca Add API documentation 6 лет назад
api_docs.md 9e78e65a56 2022 Nov 26 changelog. (#19164) 3 лет назад
api_overview.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 лет назад
arm_debugging.md 52c18ef026 [Docs] fix docs (#7642) 6 лет назад
audio_driver.md 19145704e4 [Core] Adjust PWM hardware audio driver for RP2040 (#17723) 3 лет назад
breaking_changes.md 9e78e65a56 2022 Nov 26 changelog. (#19164) 3 лет назад
breaking_changes_history.md 08805cada0 Stub next develop dates 3 лет назад
breaking_changes_instructions.md fced377ac0 2020 May 30 Breaking Changes Update (#9215) 6 лет назад
chibios_upgrade_instructions.md 5da04fb45b Update to ChibiOS 20.3.4, support builds against trunk (#14208) 4 лет назад
cli.md fcf150bd82 Streamline the macos install process 6 лет назад
cli_commands.md 959f4cbb62 docs: some typos (#18582) 3 лет назад
cli_configuration.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 лет назад
cli_development.md 959f4cbb62 docs: some typos (#18582) 3 лет назад
cli_tab_complete.md ee26d3e77f Add Zsh note for tab complete (#17226) 4 лет назад
coding_conventions_c.md 959f4cbb62 docs: some typos (#18582) 3 лет назад
coding_conventions_python.md 959f4cbb62 docs: some typos (#18582) 3 лет назад
compatible_microcontrollers.md ac5e6b6a3b Tentative Teensy 3.5 support (#14420) 4 лет назад
config_options.md cbabc8dbe6 [Core] Replace Tapping Force Hold feature with Quick Tap Term (#17007) 3 лет назад
configurator_architecture.md 9a0118c603 Architecture documentation for Configurator and API (#13935) 5 лет назад
configurator_default_keymaps.md 4d33f356a6 Macro keycode name refactoring (#18958) 3 лет назад
configurator_diagram.drawio 9a0118c603 Architecture documentation for Configurator and API (#13935) 5 лет назад
configurator_diagram.svg 9a0118c603 Architecture documentation for Configurator and API (#13935) 5 лет назад
configurator_step_by_step.md f6a7f4d4ac update the Chinese translation based on the latest English version (#14924) 4 лет назад
configurator_troubleshooting.md d5f34c4810 Polish Configurator section 6 лет назад
contributing.md f6a7f4d4ac update the Chinese translation based on the latest English version (#14924) 4 лет назад
custom_matrix.md 8224f62806 Make debounce() signal changes in the cooked matrix as return value (#17554) 4 лет назад
custom_quantum_functions.md 2c516fab29 [Docs] Extract 'Layer Change Code' and EEPROM (#18174) 3 лет назад
data_driven_config.md 479d8de622 Format DD mappings and schemas (#18924) 3 лет назад
documentation_best_practices.md 995464cb9c [Docs] fix file path (#9540) 6 лет назад
documentation_templates.md fc394dfdd4 [Docs] Fix link to keyboard layout editor (#18801) 3 лет назад
driver_installation_zadig.md 01f31bf28e [Docs] RESET -> QK_BOOT (#18365) 3 лет назад
easy_maker.md f6a7f4d4ac update the Chinese translation based on the latest English version (#14924) 4 лет назад
eeprom_driver.md 5846b40f74 RP2040 emulated EEPROM. (#17519) 4 лет назад
faq_build.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 лет назад
faq_debug.md 18dc851e37 Remove legacy Debug keycode (#18769) 3 лет назад
faq_general.md d6701b3ac7 Fix typos and reword some sentences in FAQs (#11546) 5 лет назад
faq_keymap.md d241e80533 Keymap FAQ updates (#17130) 4 лет назад
faq_misc.md 01f31bf28e [Docs] RESET -> QK_BOOT (#18365) 3 лет назад
feature_advanced_keycodes.md 2c516fab29 [Docs] Extract 'Layer Change Code' and EEPROM (#18174) 3 лет назад
feature_audio.md 69fa02c37d Align audio keycode names (#18962) 3 лет назад
feature_auto_shift.md 22be7e79ac Normalise Auto Shift keycodes (#18892) 3 лет назад
feature_autocorrect.md 2ff1d85290 Normalise Autocorrect keycodes (#18893) 3 лет назад
feature_backlight.md 219afaba42 Reworked backlight keycodes. (#18961) 3 лет назад
feature_bluetooth.md d810878d5e Normalise output selection (Bluetooth) keycodes (#19004) 3 лет назад
feature_bootmagic.md 9aaf4a5a9b Add split keyboard example for Bootmagic Lite (#16349) 4 лет назад
feature_caps_word.md a80b886751 Deprecate `CAPS_WORD`/`CAPSWRD` for `CW_TOGG` (#18834) 3 лет назад
feature_combo.md efe520645e Normalise Combo keycodes (#18877) 3 лет назад
feature_command.md a03aa301de Remove Full Bootmagic (#13846) 5 лет назад
feature_converters.md a42ab90220 Add Bonsai C4 as a platform board file (#18901) 3 лет назад
feature_debounce_type.md 25713dc222 Add sym_defer_pr debouncer type (#14948) 4 лет назад
feature_digitizer.md 6cc9513ab0 Digitizer feature improvements (#19034) 3 лет назад
feature_dip_switch.md 9d1c98c891 Added right vs left specific pin assignments for dip switch (#13074) 5 лет назад
feature_dynamic_macros.md fe18df9d41 Normalise Dynamic Macro keycodes (#18939) 3 лет назад
feature_eeprom.md 7407347be1 Remove rgblight_list.h (#18878) 3 лет назад
feature_encoders.md a4d1d8b745 Resolve conflict merging master to develop (#18297) 3 лет назад
feature_grave_esc.md b45a037c7e Rename some Quantum keycodes (#15968) 4 лет назад
feature_haptic_feedback.md e4d2ba9a4d Align haptic feedback keycode names (#18964) 3 лет назад
feature_hd44780.md 9ee2effe8e HD44780 driver rework (#16370) 4 лет назад
feature_joystick.md 1e95f7be8f Joystick feature improvements (#19052) 3 лет назад
feature_key_lock.md eeb3f9c043 Merge remote-tracking branch 'origin/master' into develop 3 лет назад
feature_key_overrides.md 1d34f380eb Deprecate `KEY_OVERRIDE_*` keycodes for `KO_*` (#18843) 3 лет назад
feature_layers.md 2c516fab29 [Docs] Extract 'Layer Change Code' and EEPROM (#18174) 3 лет назад
feature_layouts.md b56282756b [Docs] Clean up some code block languages (#14434) 4 лет назад
feature_leader_key.md b33fc34967 Deprecate `KC_LEAD` for `QK_LEAD` (#18792) 3 лет назад
feature_led_indicators.md cbe1c22d46 quantum: led: split out led_update_ports() for customization of led behaviour (#14452) 3 лет назад
feature_led_matrix.md a5a20cc792 Change `LED_MATRIX_STARTUP_*` defines to `LED_MATRIX_DEFAULT_*` (#19080) 3 лет назад
feature_macros.md 4d33f356a6 Macro keycode name refactoring (#18958) 3 лет назад
feature_midi.md 8b658dcc9a Normalise MIDI keycodes (#18972) 3 лет назад
feature_mouse_keys.md 2a61bfc27d add "inertia" mode for mouse keys (#18774) 3 лет назад
feature_oled_driver.md a5c2eea6c1 Update OLED doc (#19213) 3 лет назад
feature_os_detection.md 85ee55ff3b Detect host OS based on USB fingerprint (#18463) 3 лет назад
feature_pointing_device.md d9cba6e978 Add `*_RIGHT` configuration for PMW33XX driver (#19243) 3 лет назад
feature_programmable_button.md 6bbe8b6edd Normalise Joystick and Programmable Button keycodes (#18832) 3 лет назад
feature_ps2_mouse.md 0237ff0c62 [Core] Rework PS/2 driver selection (#17892) 3 лет назад
feature_rawhid.md b56282756b [Docs] Clean up some code block languages (#14434) 4 лет назад
feature_rgb_matrix.md e12ca14af8 Change `RGB_MATRIX_STARTUP_*` defines to `RGB_MATRIX_DEFAULT_*` (#19079) 3 лет назад
feature_rgblight.md 18dc851e37 Remove legacy Debug keycode (#18769) 3 лет назад
feature_secure.md ec2414c074 Deprecate `SECURE_*` keycodes for `QK_SECURE_*` (#18847) 3 лет назад
feature_send_string.md 3ecb0a80af Feature-ify Send String (#17275) 4 лет назад
feature_sequencer.md 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 лет назад
feature_space_cadet.md 002b58f0e4 Normalise Space Cadet keycodes (#18864) 3 лет назад
feature_split_keyboard.md c347e732be Remove legacy EEPROM clear keycodes (#18782) 3 лет назад
feature_st7565.md 37fba09021 ST7565 invert (#13237) 5 лет назад
feature_stenography.md 95c1cc425e Rename postprocess_steno_user → post_process_steno_user (#17823) 4 лет назад
feature_swap_hands.md 8d5eacb7dd Add support for encoder mapping. (#13286) 4 лет назад
feature_tap_dance.md 269600f640 Update feature_tap_dance.md (#18509) 3 лет назад
feature_unicode.md 5974d989fe Normalise Unicode keycodes (#18898) 3 лет назад
feature_userspace.md 40bc5a8192 Enable CLI flashing via mdloader (#14729) 4 лет назад
feature_velocikey.md 74484e21af Deprecate `VLK_TOG` for `VK_TOGG` (#18807) 3 лет назад
feature_wpm.md 0391801267 Fixes potential wpm sampling overflow, along with code comment fixes (#15277) 4 лет назад
flash_driver.md 71c0b97bce Added external spi flash driver. (#15419) 4 лет назад
flashing.md 01f31bf28e [Docs] RESET -> QK_BOOT (#18365) 3 лет назад
flashing_bootloadhid.md 01f31bf28e [Docs] RESET -> QK_BOOT (#18365) 3 лет назад
fuse.txt 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 лет назад
getting_started_docker.md b56282756b [Docs] Clean up some code block languages (#14434) 4 лет назад
getting_started_github.md b2a186cf92 Purge uGFX. (#14720) 4 лет назад
getting_started_introduction.md 09c7304bd9 [Docs] update git command and directory name of documents (#7619) 6 лет назад
getting_started_make_guide.md 36d123e9c5 Add support for deferred executors. (#14859) 4 лет назад
getting_started_vagrant.md b56282756b [Docs] Clean up some code block languages (#14434) 4 лет назад
gpio_control.md 75544d9127 Move Doxygen docs to subdirectory (#16561) 4 лет назад
hand_wire.md fc7e9efd21 Improve importer workflow (#17707) 4 лет назад
hardware_drivers.md b2a186cf92 Purge uGFX. (#14720) 4 лет назад
hardware_keyboard_guidelines.md 87199eb2f5 add 'info_config.h' into docs/hardware_keyboard_guidelines.md (#16247) 4 лет назад
how_a_matrix_works.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 лет назад
how_keyboards_work.md b85c224b7c docs: reflect systemd's change in language (#17322) 4 лет назад
i2c_driver.md 81be7bb7b5 Fix i2c driver doc: Incorrect name (#16898) 4 лет назад
index.html 94755308e0 Fix anchors with <code> in table of content (#15169) 4 лет назад
isp_flashing_guide.md dde4120a1e ISP flashing guide: add instructions for flashing STM32duino bootloader (#16568) 4 лет назад
keycodes.md 690eb4a453 Fix RWIN typo within keycode list (#19155) 3 лет назад
keycodes_basic.md a26f1ddafa Chromeos keycodes (#18212) 3 лет назад
keycodes_magic.md 871eeae4ea PoC: Swap Escape and Caps (#16336) 4 лет назад
keycodes_us_ansi_shifted.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) 4 лет назад
keymap.md 4b2d71de52 Remove legacy international keycodes (#18588) 3 лет назад
mod_tap.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) 4 лет назад
newbs.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 лет назад
newbs_building_firmware.md 32dabd5320 Align new-keymap with new-keyboard (#19229) 3 лет назад
newbs_building_firmware_configurator.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 лет назад
newbs_building_firmware_workflow.md 64acbcb42a [Docs] Building with GitHub Userspace (#16271) 4 лет назад
newbs_flashing.md 4e35697e1a Add note about qmk doctor in newbs_flashing.md (#15688) 4 лет назад
newbs_getting_started.md 8fa7b62011 Attempt to discourage manual MSYS install for new users (#17556) 4 лет назад
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 b56282756b [Docs] Clean up some code block languages (#14434) 4 лет назад
newbs_git_using_your_master_branch.md 54c58ea6de Add explicit id tags to externally linked headers 6 лет назад
newbs_learn_more_resources.md 70c6b183df [Docs] Refactor code examples (#18003) 4 лет назад
newbs_testing_debugging.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 лет назад
one_shot_keys.md 9ddb0165a4 fix typo (#19189) 3 лет назад
other_eclipse.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) 4 лет назад
other_vscode.md 5f72d54299 Update other_vscode.md (#17317) 4 лет назад
platformdev_blackpill_f4x1.md dbce41cb6b [Docs] Update platformdev_blackpill_f411.md (#18666) 3 лет назад
platformdev_chibios_earlyinit.md 01f31bf28e [Docs] RESET -> QK_BOOT (#18365) 3 лет назад
platformdev_proton_c.md 345e19f691 Add converter docs (#17593) 4 лет назад
platformdev_rp2040.md 9dc3f79196 [RP2040] update i2c drivers to reflect peripheral number (#19277) 3 лет назад
platformdev_selecting_arm_mcu.md 3afd2d81b8 Add documentation for selecting an Arm MCU (#9046) 6 лет назад
porting_your_keyboard_to_qmk.md 6133b08e73 Rework input_pressed_state docs (#19267) 3 лет назад
power.txt bb53635f33 Trim trailing whitespace 8 лет назад
pr_checklist.md 9e78e65a56 2022 Nov 26 changelog. (#19164) 3 лет назад
qmk.css ccc87421e7 Some more tweaks to make everything look nice 8 лет назад
qmk_custom_dark.css 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 лет назад
qmk_custom_light.css 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 лет назад
quantum_keycodes.md a6f3194397 Add ability to enter bootloader mode from `QK_MAKE` (#17745) 4 лет назад
quantum_painter.md 9daf77b593 Add raw output option for QGF/QFF files. (#18998) 3 лет назад
quantum_painter_lvgl.md 102f22f7e9 [Core] Quantum Painter - LVGL Integration (#18499) 3 лет назад
quantum_painter_qff.md 1f2b1dedcc Quantum Painter (#10174) 4 лет назад
quantum_painter_qgf.md 1f2b1dedcc Quantum Painter (#10174) 4 лет назад
quantum_painter_rle.md 1f2b1dedcc Quantum Painter (#10174) 4 лет назад
redirects.json d569f08771 Configuration system for CLI (#6708) 6 лет назад
ref_functions.md c347e732be Remove legacy EEPROM clear keycodes (#18782) 3 лет назад
reference_configurator_support.md f529580860 Basic keycode overhaul (#14726) 4 лет назад
reference_glossary.md 014aa0661e Fix Space Cadet md link (#14300) 4 лет назад
reference_info_json.md 6133b08e73 Rework input_pressed_state docs (#19267) 3 лет назад
reference_keymap_extras.md 4a8bd7b9a5 Rename keymap_extras headers for consistency (#16939) 4 лет назад
serial_driver.md 40aa9c8745 spelling fix (#18831) 3 лет назад
spi_driver.md 0e59827023 Merge remote-tracking branch 'upstream/master' into develop 5 лет назад
squeezing_avr.md fb6e821541 Add Elite-Pi converter (#18236) 3 лет назад
support.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 лет назад
sw.js 303f425c6b Fix up info boxes. 8 лет назад
syllabus.md f4966a19d6 [Docs] Squeezing space out of AVR (#15243) 4 лет назад
tap_hold.md cbabc8dbe6 [Core] Replace Tapping Force Hold feature with Quick Tap Term (#17007) 3 лет назад
translating.md 7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) 6 лет назад
uart_driver.md 04b51e381e Update UART driver API (#14839) 4 лет назад
understanding_qmk.md 5233c69bc6 Remove thermal printer. (#18959) 3 лет назад
unit_testing.md 1c0347b8b8 Remove SERIAL_LINK feature (#14727) 4 лет назад
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores 9 лет назад
ws2812_driver.md 27dec8d16d [Core] Allow custom timings for WS2812 PIO driver (#18006) 3 лет назад

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.