1
0
precondition 4bac5f53d8 New feature: `DYNAMIC_TAPPING_TERM_ENABLE` (#11036) 4 жил өмнө
..
ChangeLog 6caebb7b61 Bootmagic lite docs clarity. (#14204) 5 жил өмнө
de 596c4a1f87 Remove bin/qmk (#14231) 5 жил өмнө
es b2a186cf92 Purge uGFX. (#14720) 4 жил өмнө
fr-fr 2728603fe6 Move tmk_core/common/<plat> (#13918) 4 жил өмнө
gitbook 4580d3a730 RGB improvements (#1684) 9 жил өмнө
he-il b2a186cf92 Purge uGFX. (#14720) 4 жил өмнө
ja 282e916d86 Remove use of __flash due to LTO issues (#15268) 4 жил өмнө
ko-kr c71d67ba3f [Core] [Docs] Remove travis-ci references (#13916) 5 жил өмнө
pt-br c71d67ba3f [Core] [Docs] Remove travis-ci references (#13916) 5 жил өмнө
ru-ru b2a186cf92 Purge uGFX. (#14720) 4 жил өмнө
zh-cn 2728603fe6 Move tmk_core/common/<plat> (#13918) 4 жил өмнө
.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 0ee9c41cc6 Fix hebrew emoji in langs.md (#15140) 4 жил өмнө
_summary.md f4966a19d6 [Docs] Squeezing space out of AVR (#15243) 4 жил өмнө
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 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 b56282756b [Docs] Clean up some code block languages (#14434) 4 жил өмнө
breaking_changes.md 4bad375d7c 2021Q3 pre-merge `develop` changelog, keyboard aliases (#14198) 5 жил өмнө
breaking_changes_history.md 4bad375d7c 2021Q3 pre-merge `develop` changelog, keyboard aliases (#14198) 5 жил өмнө
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 92e9bbd9b9 Merge remote-tracking branch 'upstream/master' into develop 4 жил өмнө
cli_configuration.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 жил өмнө
cli_development.md b56282756b [Docs] Clean up some code block languages (#14434) 4 жил өмнө
cli_tab_complete.md 0002acd4a3 Fix Typo in documentation (#14942) 4 жил өмнө
coding_conventions_c.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 жил өмнө
coding_conventions_python.md fefd7fdc51 Refactor new-keyboard to be python3.7 compatible (#14707) 4 жил өмнө
compatible_microcontrollers.md e50867d52d [Core] Add support for RISC-V builds and GD32VF103 MCU (#12508) 4 жил өмнө
config_options.md 4bac5f53d8 New feature: `DYNAMIC_TAPPING_TERM_ENABLE` (#11036) 4 жил өмнө
configurator_architecture.md 9a0118c603 Architecture documentation for Configurator and API (#13935) 5 жил өмнө
configurator_default_keymaps.md f529580860 Basic keycode overhaul (#14726) 4 жил өмнө
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 e4823aadec Fix capitalisation of "GitHub" (#9184) 6 жил өмнө
configurator_troubleshooting.md d5f34c4810 Polish Configurator section 6 жил өмнө
contributing.md 596c4a1f87 Remove bin/qmk (#14231) 5 жил өмнө
custom_matrix.md b56282756b [Docs] Clean up some code block languages (#14434) 4 жил өмнө
custom_quantum_functions.md 36d123e9c5 Add support for deferred executors. (#14859) 4 жил өмнө
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 e50867d52d [Core] Add support for RISC-V builds and GD32VF103 MCU (#12508) 4 жил өмнө
easy_maker.md 60a36863bc [Keyboard] ez_maker/directpins for easy one-offs in qmk_configurator (#13321) 5 жил өмнө
eeprom_driver.md dd16d3cc7e eeprom_i2c driver: added EXTERNAL_EEPROM_WP_PIN configuration option. (#12617) 5 жил өмнө
faq_build.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 жил өмнө
faq_debug.md b56282756b [Docs] Clean up some code block languages (#14434) 4 жил өмнө
faq_general.md d6701b3ac7 Fix typos and reword some sentences in FAQs (#11546) 5 жил өмнө
faq_keymap.md f529580860 Basic keycode overhaul (#14726) 4 жил өмнө
faq_misc.md 84ea77ead6 Remove `BOOTMAGIC_ENABLE = lite` option (#15002) 4 жил өмнө
feature_advanced_keycodes.md 92dd1b977b Additional documentation for GUI mod combo (#13266) 5 жил өмнө
feature_audio.md 4e3726bfe1 Fixup Audio startup and add to documents (#13606) 5 жил өмнө
feature_auto_shift.md d9393b8684 Add Retro Shift (Auto Shift for Tap Hold via Retro Tapping) and Custom Auto Shifts (#11059) 4 жил өмнө
feature_backlight.md b56282756b [Docs] Clean up some code block languages (#14434) 4 жил өмнө
feature_bluetooth.md db41a3426c Improve Adafruit BLE configuration defines (#14749) 4 жил өмнө
feature_bootmagic.md 84ea77ead6 Remove `BOOTMAGIC_ENABLE = lite` option (#15002) 4 жил өмнө
feature_combo.md 3fd6ae93ad Merge remote-tracking branch 'origin/master' into develop 4 жил өмнө
feature_command.md a03aa301de Remove Full Bootmagic (#13846) 5 жил өмнө
feature_debounce_type.md c0628c2820 Remove backwards compatibility of debounce names (#13877) 5 жил өмнө
feature_digitizer.md b56282756b [Docs] Clean up some code block languages (#14434) 4 жил өмнө
feature_dip_switch.md 9d1c98c891 Added right vs left specific pin assignments for dip switch (#13074) 5 жил өмнө
feature_dynamic_macros.md cdb69da86e Fix typo in docs/feature_dynamic_macros (#10085) 6 жил өмнө
feature_encoders.md 32215d5bff Rework encoders to enable asymmetric split keyboards (#12090) 4 жил өмнө
feature_grave_esc.md f529580860 Basic keycode overhaul (#14726) 4 жил өмнө
feature_haptic_feedback.md f529580860 Basic keycode overhaul (#14726) 4 жил өмнө
feature_hd44780.md d846660e00 fixed typo for clear lcd screen function in hd44780 docs (#9086) 6 жил өмнө
feature_joystick.md b56282756b [Docs] Clean up some code block languages (#14434) 4 жил өмнө
feature_key_lock.md 54c58ea6de Add explicit id tags to externally linked headers 6 жил өмнө
feature_key_overrides.md f529580860 Basic keycode overhaul (#14726) 4 жил өмнө
feature_layers.md 2728603fe6 Move tmk_core/common/<plat> (#13918) 4 жил өмнө
feature_layouts.md b56282756b [Docs] Clean up some code block languages (#14434) 4 жил өмнө
feature_leader_key.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 5 жил өмнө
feature_led_indicators.md 12a8e59e9c [Docs] add sync options heading, update led indicators (#14441) 4 жил өмнө
feature_led_matrix.md 282e916d86 Remove use of __flash due to LTO issues (#15268) 4 жил өмнө
feature_macros.md 08ce0142ba Macros in JSON keymaps (#14374) 4 жил өмнө
feature_midi.md b56282756b [Docs] Clean up some code block languages (#14434) 4 жил өмнө
feature_mouse_keys.md 99f3df2893 Add support for 8 buttons to mouse report (#10807) 5 жил өмнө
feature_oled_driver.md 464d67c68f Merge remote-tracking branch 'origin/master' into develop 4 жил өмнө
feature_pointing_device.md 56e3f06a26 Rework and expand Pointing Device support (#14343) 4 жил өмнө
feature_programmable_button.md 83988597f4 Add Support for USB programmable buttons (#12950) 4 жил өмнө
feature_ps2_mouse.md 84d5198ef9 Align PS/2 GPIO defines (#14745) 4 жил өмнө
feature_rawhid.md b56282756b [Docs] Clean up some code block languages (#14434) 4 жил өмнө
feature_rgb_matrix.md 282e916d86 Remove use of __flash due to LTO issues (#15268) 4 жил өмнө
feature_rgblight.md fb9a254a43 Retain brightness with lighting layers (#13025) 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 12a8e59e9c [Docs] add sync options heading, update led indicators (#14441) 4 жил өмнө
feature_st7565.md 37fba09021 ST7565 invert (#13237) 5 жил өмнө
feature_stenography.md aa712b5e28 Merge remote-tracking branch 'origin/master' into develop 4 жил өмнө
feature_swap_hands.md b56282756b [Docs] Clean up some code block languages (#14434) 4 жил өмнө
feature_tap_dance.md f529580860 Basic keycode overhaul (#14726) 4 жил өмнө
feature_terminal.md b23f6011c3 Remove build option firmware size impacts (#6947) 6 жил өмнө
feature_thermal_printer.md 4c675a83ba Format keycode tables 8 жил өмнө
feature_unicode.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 5 жил өмнө
feature_userspace.md 40bc5a8192 Enable CLI flashing via mdloader (#14729) 4 жил өмнө
feature_velocikey.md 84ea77ead6 Remove `BOOTMAGIC_ENABLE = lite` option (#15002) 4 жил өмнө
feature_wpm.md c9fd698711 Reimplements WPM feature to be smaller & precise (#13902) 4 жил өмнө
flashing.md d5cb7de5e4 Change USBasp and bootloadHID bootloaders to lowercase (#14354) 5 жил өмнө
flashing_bootloadhid.md b56282756b [Docs] Clean up some code block languages (#14434) 4 жил өмнө
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 жил өмнө
hand_wire.md 6fd9b2feba [Docs] Added information on soldering diodes in parallel (#13117) 5 жил өмнө
hardware_avr.md b021c2f2c5 Port new_keyboard.sh to CLI (#13706) 5 жил өмнө
hardware_drivers.md b2a186cf92 Purge uGFX. (#14720) 4 жил өмнө
hardware_keyboard_guidelines.md b2a186cf92 Purge uGFX. (#14720) 4 жил өмнө
how_a_matrix_works.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 жил өмнө
how_keyboards_work.md b56282756b [Docs] Clean up some code block languages (#14434) 4 жил өмнө
i2c_driver.md bc1f5ef381 i2c_master: Add support for reading/writing to 16-bit registers (#14289) 4 жил өмнө
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 2728603fe6 Move tmk_core/common/<plat> (#13918) 4 жил өмнө
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 cc5a38e787 Rework ISP flashing guide (#14938) 4 жил өмнө
keycodes.md 4bac5f53d8 New feature: `DYNAMIC_TAPPING_TERM_ENABLE` (#11036) 4 жил өмнө
keycodes_basic.md f529580860 Basic keycode overhaul (#14726) 4 жил өмнө
keycodes_magic.md 4c4f632378 Add a toggle key for GUI On/Off in Magic feature (#13830) 5 жил өмнө
keycodes_us_ansi_shifted.md 40de65eac4 Backslash-escape pipe character in keycode lists (#7157) 6 жил өмнө
keymap.md f529580860 Basic keycode overhaul (#14726) 4 жил өмнө
mod_tap.md 57f63e43d8 [Docs] Correct logic of tap hold statement (#14992) 4 жил өмнө
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 9b912416b4 [Docs] Add instructions to create keymap before proceeding (#14945) 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 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 fcce9f2a4f fix: Fix typo in documentation for one shot keys. ON_TOGG -> OS_TOGG (#13754) 5 жил өмнө
other_eclipse.md cfbd9ba0e7 eclipse: recommend changing the default project make target (#12447) 5 жил өмнө
other_vscode.md c71d67ba3f [Core] [Docs] Remove travis-ci references (#13916) 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 2728603fe6 Move tmk_core/common/<plat> (#13918) 4 жил өмнө
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) 6 жил өмнө
ref_functions.md a03aa301de Remove Full Bootmagic (#13846) 5 жил өмнө
reference_configurator_support.md f529580860 Basic keycode overhaul (#14726) 4 жил өмнө
reference_glossary.md 014aa0661e Fix Space Cadet md link (#14300) 5 жил өмнө
reference_info_json.md b7a346600c [Docs] Clean up reference_info_json.md (#14806) 4 жил өмнө
reference_keymap_extras.md fce12f0075 Rework keymap_extras docs (#13949) 5 жил өмнө
serial_driver.md 0ae20e7457 Make solo half of split keyboards (more) usable. (#13523) 5 жил өмнө
spi_driver.md 0e59827023 Merge remote-tracking branch 'upstream/master' into develop 5 жил өмнө
squeezing_avr.md f4966a19d6 [Docs] Squeezing space out of AVR (#15243) 4 жил өмнө
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 4bac5f53d8 New feature: `DYNAMIC_TAPPING_TERM_ENABLE` (#11036) 4 жил өмнө
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 4bac5f53d8 New feature: `DYNAMIC_TAPPING_TERM_ENABLE` (#11036) 4 жил өмнө
unit_testing.md 1c0347b8b8 Remove SERIAL_LINK feature (#14727) 4 жил өмнө
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores 9 жил өмнө
ws2812_driver.md 5e9c29da0d Tidy up adjustable ws2812 timing (#15299) 4 жил өмнө

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.