Drashna Jaelre f0b30e0027 Make Swap Hands use PROGMEM (#12284) 5 лет назад
..
ChangeLog a8d64c8b89 Change `BOOTMAGIC_ENABLE=yes` to use Bootmagic Lite (#12172) 5 лет назад
de 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 лет назад
es 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 лет назад
fr-fr 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 лет назад
gitbook 4580d3a730 RGB improvements (#1684) 9 лет назад
he-il 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 лет назад
ja f0b30e0027 Make Swap Hands use PROGMEM (#12284) 5 лет назад
ko-kr 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 лет назад
pt-br 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 лет назад
ru-ru 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 лет назад
zh-cn 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 лет назад
.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 10e8ed7430 [Docs] add README translation in portuguese (#7016) 6 лет назад
_summary.md 588bcdc8ca Add support for tab completion (#12411) 5 лет назад
adc_driver.md 65c9752762 Update ADC driver for STM32F1xx, STM32F3xx, STM32F4xx (#12403) 5 лет назад
api_development_environment.md 99850aabca Add API documentation 6 лет назад
api_development_overview.md 99850aabca Add API documentation 6 лет назад
api_docs.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 лет назад
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 c80e5f9f88 Audio system overhaul (#11820) 5 лет назад
breaking_changes.md 1a913aa12e Fix Breaking Change date (#12272) 5 лет назад
breaking_changes_history.md 624359b725 2021 February 27 Breaking Changes Changelog (#11975) 5 лет назад
breaking_changes_instructions.md fced377ac0 2020 May 30 Breaking Changes Update (#9215) 6 лет назад
cli.md fcf150bd82 Streamline the macos install process 6 лет назад
cli_commands.md 7a25dcacff New command: qmk console (#12828) 5 лет назад
cli_configuration.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 лет назад
cli_development.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 лет назад
cli_tab_complete.md 588bcdc8ca Add support for tab completion (#12411) 5 лет назад
coding_conventions_c.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 лет назад
coding_conventions_python.md 66d94dc22a Move everything to Python 3.6 (#8835) 6 лет назад
compatible_microcontrollers.md 9cf82fae95 Add STM32L433 and L443 support (#12063) 5 лет назад
config_options.md c80e5f9f88 Audio system overhaul (#11820) 5 лет назад
configurator_default_keymaps.md de68d294ec [Docs] add "Adding Default Keymaps to QMK Configurator" doc (#10049) 5 лет назад
configurator_step_by_step.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 лет назад
configurator_troubleshooting.md d5f34c4810 Polish Configurator section 6 лет назад
contributing.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 лет назад
custom_matrix.md 6e710426a4 Add docs for 'CUSTOM_MATRIX = lite' (#7906) 6 лет назад
custom_quantum_functions.md c66df16644 2020 November 28 Breaking Changes Update (#11053) 5 лет назад
data_driven_config.md ef6329af7c Create a system to map between info.json and config.h/rules.mk (#11548) 5 лет назад
documentation_best_practices.md 995464cb9c [Docs] fix file path (#9540) 6 лет назад
documentation_templates.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 лет назад
driver_installation_zadig.md 10096fc42e Zadig docs: add APM32 device name (#11356) 5 лет назад
eeprom_driver.md 70f40339c2 Add i2c 24LC64 eeprom (#11200) 5 лет назад
faq_build.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 лет назад
faq_debug.md 4c3090ace9 Documentation changes SPLIT_USB_DETECT and hid_listen udev rules (#11665) 5 лет назад
faq_general.md d6701b3ac7 Fix typos and reword some sentences in FAQs (#11546) 5 лет назад
faq_keymap.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 лет назад
faq_misc.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 лет назад
feature_advanced_keycodes.md 2395069b0b [Docs] New section to modifier docs: Checking Modifier State (#10550) 5 лет назад
feature_audio.md 0f516d9026 A few small typo fixes in docs (#12524) 5 лет назад
feature_auto_shift.md c02137a0d2 Add Per Key functionality for AutoShift (#11536) 5 лет назад
feature_backlight.md 0f516d9026 A few small typo fixes in docs (#12524) 5 лет назад
feature_bluetooth.md 0fbb1e550a Add description in Bluetooth docs for requiring NKRO to be disabled (#10359) 5 лет назад
feature_bootmagic.md 789e199450 Add support for Bootmagic lite when using SPLIT_HAND_PIN (#8347) 6 лет назад
feature_combo.md 49abff9071 changed type of process_combo_event argument in tutorial (#10621) 5 лет назад
feature_command.md a2e91ebec9 Update IS_COMMAND definitions to use MOD_MASK_SHIFT (#6348) 7 лет назад
feature_debounce_type.md 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 лет назад
feature_dip_switch.md c2ca57c8f4 add DIP_SWITCH_MATRIX_GRID support (#8772) 6 лет назад
feature_dynamic_macros.md cdb69da86e Fix typo in docs/feature_dynamic_macros (#10085) 6 лет назад
feature_encoders.md f3a1629469 Add docs on multiple encoders sharing pins (#11678) 5 лет назад
feature_grave_esc.md 3510d8dc8d Document an annoyance with Grave Escape and macOS Terminal (#5483) 7 лет назад
feature_haptic_feedback.md 6a5f29208e [Docs] Update feature_haptic_feedback.md (#11859) 5 лет назад
feature_hd44780.md d846660e00 fixed typo for clear lcd screen function in hd44780 docs (#9086) 6 лет назад
feature_joystick.md c66df16644 2020 November 28 Breaking Changes Update (#11053) 5 лет назад
feature_key_lock.md 54c58ea6de Add explicit id tags to externally linked headers 6 лет назад
feature_layers.md eac9ee8d3f Improve upon the 'Caveats' section of the Layers and Mod-Tap documentation (#12306) 5 лет назад
feature_layouts.md 40e67a3074 Add a mechanism for force building a particular community layout (#5027) 7 лет назад
feature_leader_key.md 26b9b3aa23 feat: infinite timeout for leader key (#6580) 5 лет назад
feature_led_indicators.md 1ff5ee255f Indicator LEDs as config (#10816) 5 лет назад
feature_led_matrix.md a28fbcda23 Terrazzo: Fix wrong LED Matrix function names (#12561) 5 лет назад
feature_macros.md 2395069b0b [Docs] New section to modifier docs: Checking Modifier State (#10550) 5 лет назад
feature_mouse_keys.md 99f3df2893 Add support for 8 buttons to mouse report (#10807) 5 лет назад
feature_oled_driver.md fca7cc1747 Added OLED fade out support (#12086) 5 лет назад
feature_pointing_device.md 711388d3e3 Merge remote-tracking branch 'origin/master' into develop 5 лет назад
feature_ps2_mouse.md 92543a7cb5 fix(feature_ps2_mouse): fix Scroll Button example (#11669) 5 лет назад
feature_rawhid.md dee506c096 Updated Raw HID docs to clarify packet/report length (#11211) 5 лет назад
feature_rgb_matrix.md d8167779cd Change RGB/LED Matrix to use a simple define for USB suspend (#12697) 5 лет назад
feature_rgblight.md e2289ffac0 Add missing RGB_MODE_TWINKLE / RGB_M_TW keycodes (#11935) 5 лет назад
feature_sequencer.md 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 лет назад
feature_space_cadet.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 лет назад
feature_split_keyboard.md 4c3090ace9 Documentation changes SPLIT_USB_DETECT and hid_listen udev rules (#11665) 5 лет назад
feature_stenography.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 лет назад
feature_swap_hands.md f0b30e0027 Make Swap Hands use PROGMEM (#12284) 5 лет назад
feature_tap_dance.md 653ecf91c2 More Tap Dance docs improvements (#12358) 5 лет назад
feature_terminal.md b23f6011c3 Remove build option firmware size impacts (#6947) 6 лет назад
feature_thermal_printer.md 4c675a83ba Format keycode tables 8 лет назад
feature_unicode.md bcbcb3d107 Add suggestion for indirect unicode input on Linux (#10854) 5 лет назад
feature_userspace.md 501f2fdef1 Normalise include statements in core code (#11153) 5 лет назад
feature_velocikey.md c1c5922aae Velocikey: Match RGB animation speed to typing speed (#3754) 7 лет назад
feature_wpm.md 180a32ec59 Enhancement of WPM feature (#11727) 5 лет назад
flashing.md 891d18d356 Add initial support for tinyuf2 bootloader (when hosted on F411 blackpill) (#12600) 5 лет назад
flashing_bootloadhid.md 235da6973d Install bootloadHid as part of qmk_install (#7463) 6 лет назад
fuse.txt 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 лет назад
getting_started_docker.md e4d3ff2374 Add support for using podman to util/docker_build.sh (#10819) 5 лет назад
getting_started_github.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 лет назад
getting_started_introduction.md 09c7304bd9 [Docs] update git command and directory name of documents (#7619) 6 лет назад
getting_started_make_guide.md b23eeb6a14 Documentation update (#12484) 5 лет назад
getting_started_vagrant.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 лет назад
hand_wire.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 лет назад
hardware_avr.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 лет назад
hardware_drivers.md d13ada1162 Add customisable EEPROM driver selection (#7274) 6 лет назад
hardware_keyboard_guidelines.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 лет назад
how_a_matrix_works.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 лет назад
how_keyboards_work.md d5316e9714 Update URL for `60-keyboard.hwdb` (#7185) 6 лет назад
i2c_driver.md 5d5cbb877d Rework I2C driver docs (#11658) 5 лет назад
index.html bbf0f65284 Simplify the visual flow of the getting started page (#11316) 5 лет назад
internals_defines.md ae7284edb8 rename api docs to internals 8 лет назад
internals_gpio_control.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 лет назад
internals_input_callback_reg.md ae7284edb8 rename api docs to internals 8 лет назад
internals_midi_device.md ae7284edb8 rename api docs to internals 8 лет назад
internals_midi_device_setup_process.md ae7284edb8 rename api docs to internals 8 лет назад
internals_midi_util.md ae7284edb8 rename api docs to internals 8 лет назад
internals_send_functions.md ae7284edb8 rename api docs to internals 8 лет назад
internals_sysex_tools.md ae7284edb8 rename api docs to internals 8 лет назад
isp_flashing_guide.md 9d1d875a95 [Docs] Update isp_flashing_guide.md (#11777) 5 лет назад
keycodes.md 0e984b6e7e Add ability to toggle One Shot functionality (#4198) 5 лет назад
keycodes_basic.md 962b8d3814 Update keycode docs (#11343) 5 лет назад
keycodes_us_ansi_shifted.md 40de65eac4 Backslash-escape pipe character in keycode lists (#7157) 6 лет назад
keymap.md 142ebaea46 [Docs] Clarify layer transparency keymap.md (#9081) 6 лет назад
mod_tap.md eac9ee8d3f Improve upon the 'Caveats' section of the Layers and Mod-Tap documentation (#12306) 5 лет назад
newbs.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 лет назад
newbs_building_firmware.md 54c58ea6de Add explicit id tags to externally linked headers 6 лет назад
newbs_building_firmware_configurator.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 лет назад
newbs_flashing.md 0f516d9026 A few small typo fixes in docs (#12524) 5 лет назад
newbs_getting_started.md 189e0d5b98 Update FreeBSD install method (#12815) 5 лет назад
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 26a823082b [Docs] Fix minor differences in docs/newbs_git_resynchronize_a_branch.md (#7728) 6 лет назад
newbs_git_using_your_master_branch.md 54c58ea6de Add explicit id tags to externally linked headers 6 лет назад
newbs_learn_more_resources.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 лет назад
newbs_testing_debugging.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 лет назад
one_shot_keys.md 0e984b6e7e Add ability to toggle One Shot functionality (#4198) 5 лет назад
other_eclipse.md cfbd9ba0e7 eclipse: recommend changing the default project make target (#12447) 5 лет назад
other_vscode.md a2af0a352b Update other_vscode.md of Japanese document (#10604) 5 лет назад
platformdev_chibios_earlyinit.md 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 лет назад
platformdev_selecting_arm_mcu.md 3afd2d81b8 Add documentation for selecting an Arm MCU (#9046) 6 лет назад
power.txt bb53635f33 Trim trailing whitespace 8 лет назад
pr_checklist.md 6b5e349d7e Add additional info to PR Checklist (#12630) 5 лет назад
proton_c_conversion.md 87291437bd Add board specific to Proton-C, with usual defaults turned on. (#10976) 5 лет назад
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 54c58ea6de Add explicit id tags to externally linked headers 6 лет назад
redirects.json d569f08771 Configuration system for CLI (#6708) 7 лет назад
ref_functions.md bf1c40d682 [Docs] Add EEP_RST keycode to "Wiping the EEPROM" section (#11830) 5 лет назад
reference_configurator_support.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 лет назад
reference_glossary.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 лет назад
reference_info_json.md a0e7333915 Merge remote-tracking branch 'origin/master' into develop 5 лет назад
reference_keymap_extras.md e190872b82 Improved Language Specific Keycodes for US International and Extended Layouts (#11307) 5 лет назад
serial_driver.md 990d5189d1 Configurable serial usart timeout (#11057) 5 лет назад
spi_driver.md 0e59827023 Merge remote-tracking branch 'upstream/master' into develop 5 лет назад
support.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 лет назад
sw.js 303f425c6b Fix up info boxes. 8 лет назад
syllabus.md 9b70e53508 [Docs] Fixed minor typos (#8860) 6 лет назад
tap_hold.md 3559284839 Update IGNORE_MOD_TAP_INTERRUPT (#11452) 5 лет назад
translating.md 7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) 6 лет назад
uart_driver.md 30b46fad57 UART driver refactor (#11637) 5 лет назад
understanding_qmk.md d1806a26e4 Split transport mirror (#11046) 5 лет назад
unit_testing.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 лет назад
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores 9 лет назад
ws2812_driver.md 6f7466b6dd ARM WS2812 SPI config (baudrate and circular buffer) (#12216) 5 лет назад

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.