Nick Brassel 88fe5c16a5 Changelog 2021q4 (#15325) il y a 4 ans
..
ChangeLog 88fe5c16a5 Changelog 2021q4 (#15325) il y a 4 ans
de 596c4a1f87 Remove bin/qmk (#14231) il y a 5 ans
es b2a186cf92 Purge uGFX. (#14720) il y a 4 ans
fr-fr 2728603fe6 Move tmk_core/common/<plat> (#13918) il y a 4 ans
gitbook 4580d3a730 RGB improvements (#1684) il y a 9 ans
he-il b2a186cf92 Purge uGFX. (#14720) il y a 4 ans
ja 282e916d86 Remove use of __flash due to LTO issues (#15268) il y a 4 ans
ko-kr c71d67ba3f [Core] [Docs] Remove travis-ci references (#13916) il y a 5 ans
pt-br c71d67ba3f [Core] [Docs] Remove travis-ci references (#13916) il y a 5 ans
ru-ru b2a186cf92 Purge uGFX. (#14720) il y a 4 ans
zh-cn 2728603fe6 Move tmk_core/common/<plat> (#13918) il y a 4 ans
.nojekyll 9e5676650e Use docsfy to replace gitbook il y a 8 ans
CNAME 4d26137e2a Create CNAME il y a 8 ans
README.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) il y a 5 ans
_langs.md 0ee9c41cc6 Fix hebrew emoji in langs.md (#15140) il y a 4 ans
_summary.md 88fe5c16a5 Changelog 2021q4 (#15325) il y a 4 ans
adc_driver.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) il y a 5 ans
api_development_environment.md 99850aabca Add API documentation il y a 6 ans
api_development_overview.md 99850aabca Add API documentation il y a 6 ans
api_docs.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) il y a 5 ans
api_overview.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) il y a 5 ans
arm_debugging.md 52c18ef026 [Docs] fix docs (#7642) il y a 6 ans
audio_driver.md b56282756b [Docs] Clean up some code block languages (#14434) il y a 5 ans
breaking_changes.md 88fe5c16a5 Changelog 2021q4 (#15325) il y a 4 ans
breaking_changes_history.md 88fe5c16a5 Changelog 2021q4 (#15325) il y a 4 ans
breaking_changes_instructions.md fced377ac0 2020 May 30 Breaking Changes Update (#9215) il y a 6 ans
chibios_upgrade_instructions.md 5da04fb45b Update to ChibiOS 20.3.4, support builds against trunk (#14208) il y a 4 ans
cli.md fcf150bd82 Streamline the macos install process il y a 6 ans
cli_commands.md 92e9bbd9b9 Merge remote-tracking branch 'upstream/master' into develop il y a 4 ans
cli_configuration.md e4823aadec Fix capitalisation of "GitHub" (#9184) il y a 6 ans
cli_development.md b56282756b [Docs] Clean up some code block languages (#14434) il y a 5 ans
cli_tab_complete.md 0002acd4a3 Fix Typo in documentation (#14942) il y a 4 ans
coding_conventions_c.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) il y a 5 ans
coding_conventions_python.md fefd7fdc51 Refactor new-keyboard to be python3.7 compatible (#14707) il y a 4 ans
compatible_microcontrollers.md 68838bb700 Westberrytech pr (#14422) il y a 4 ans
config_options.md 4bac5f53d8 New feature: `DYNAMIC_TAPPING_TERM_ENABLE` (#11036) il y a 4 ans
configurator_architecture.md 9a0118c603 Architecture documentation for Configurator and API (#13935) il y a 5 ans
configurator_default_keymaps.md f529580860 Basic keycode overhaul (#14726) il y a 4 ans
configurator_diagram.drawio 9a0118c603 Architecture documentation for Configurator and API (#13935) il y a 5 ans
configurator_diagram.svg 9a0118c603 Architecture documentation for Configurator and API (#13935) il y a 5 ans
configurator_step_by_step.md e4823aadec Fix capitalisation of "GitHub" (#9184) il y a 6 ans
configurator_troubleshooting.md d5f34c4810 Polish Configurator section il y a 6 ans
contributing.md 596c4a1f87 Remove bin/qmk (#14231) il y a 5 ans
custom_matrix.md b56282756b [Docs] Clean up some code block languages (#14434) il y a 5 ans
custom_quantum_functions.md 36d123e9c5 Add support for deferred executors. (#14859) il y a 4 ans
data_driven_config.md ef6329af7c Create a system to map between info.json and config.h/rules.mk (#11548) il y a 5 ans
documentation_best_practices.md 995464cb9c [Docs] fix file path (#9540) il y a 6 ans
documentation_templates.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) il y a 5 ans
driver_installation_zadig.md e50867d52d [Core] Add support for RISC-V builds and GD32VF103 MCU (#12508) il y a 4 ans
easy_maker.md 60a36863bc [Keyboard] ez_maker/directpins for easy one-offs in qmk_configurator (#13321) il y a 5 ans
eeprom_driver.md dd16d3cc7e eeprom_i2c driver: added EXTERNAL_EEPROM_WP_PIN configuration option. (#12617) il y a 5 ans
faq_build.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) il y a 5 ans
faq_debug.md b56282756b [Docs] Clean up some code block languages (#14434) il y a 5 ans
faq_general.md d6701b3ac7 Fix typos and reword some sentences in FAQs (#11546) il y a 5 ans
faq_keymap.md f529580860 Basic keycode overhaul (#14726) il y a 4 ans
faq_misc.md 84ea77ead6 Remove `BOOTMAGIC_ENABLE = lite` option (#15002) il y a 4 ans
feature_advanced_keycodes.md 92dd1b977b Additional documentation for GUI mod combo (#13266) il y a 5 ans
feature_audio.md 4e3726bfe1 Fixup Audio startup and add to documents (#13606) il y a 5 ans
feature_auto_shift.md d9393b8684 Add Retro Shift (Auto Shift for Tap Hold via Retro Tapping) and Custom Auto Shifts (#11059) il y a 4 ans
feature_backlight.md b56282756b [Docs] Clean up some code block languages (#14434) il y a 5 ans
feature_bluetooth.md db41a3426c Improve Adafruit BLE configuration defines (#14749) il y a 4 ans
feature_bootmagic.md 84ea77ead6 Remove `BOOTMAGIC_ENABLE = lite` option (#15002) il y a 4 ans
feature_combo.md 3fd6ae93ad Merge remote-tracking branch 'origin/master' into develop il y a 4 ans
feature_command.md a03aa301de Remove Full Bootmagic (#13846) il y a 5 ans
feature_debounce_type.md c0628c2820 Remove backwards compatibility of debounce names (#13877) il y a 5 ans
feature_digitizer.md b56282756b [Docs] Clean up some code block languages (#14434) il y a 5 ans
feature_dip_switch.md 9d1c98c891 Added right vs left specific pin assignments for dip switch (#13074) il y a 5 ans
feature_dynamic_macros.md cdb69da86e Fix typo in docs/feature_dynamic_macros (#10085) il y a 6 ans
feature_encoders.md 4d0dd1eab7 [Bug] Revert Assymmetrical Split Encoder support (#12090) (#15311) il y a 4 ans
feature_grave_esc.md f529580860 Basic keycode overhaul (#14726) il y a 4 ans
feature_haptic_feedback.md f529580860 Basic keycode overhaul (#14726) il y a 4 ans
feature_hd44780.md d846660e00 fixed typo for clear lcd screen function in hd44780 docs (#9086) il y a 6 ans
feature_joystick.md b56282756b [Docs] Clean up some code block languages (#14434) il y a 5 ans
feature_key_lock.md 54c58ea6de Add explicit id tags to externally linked headers il y a 6 ans
feature_key_overrides.md f529580860 Basic keycode overhaul (#14726) il y a 4 ans
feature_layers.md 2728603fe6 Move tmk_core/common/<plat> (#13918) il y a 4 ans
feature_layouts.md b56282756b [Docs] Clean up some code block languages (#14434) il y a 5 ans
feature_leader_key.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) il y a 5 ans
feature_led_indicators.md 12a8e59e9c [Docs] add sync options heading, update led indicators (#14441) il y a 5 ans
feature_led_matrix.md 282e916d86 Remove use of __flash due to LTO issues (#15268) il y a 4 ans
feature_macros.md 08ce0142ba Macros in JSON keymaps (#14374) il y a 4 ans
feature_midi.md b56282756b [Docs] Clean up some code block languages (#14434) il y a 5 ans
feature_mouse_keys.md 99f3df2893 Add support for 8 buttons to mouse report (#10807) il y a 5 ans
feature_oled_driver.md 464d67c68f Merge remote-tracking branch 'origin/master' into develop il y a 4 ans
feature_pointing_device.md 56e3f06a26 Rework and expand Pointing Device support (#14343) il y a 4 ans
feature_programmable_button.md 83988597f4 Add Support for USB programmable buttons (#12950) il y a 5 ans
feature_ps2_mouse.md 84d5198ef9 Align PS/2 GPIO defines (#14745) il y a 4 ans
feature_rawhid.md b56282756b [Docs] Clean up some code block languages (#14434) il y a 5 ans
feature_rgb_matrix.md 282e916d86 Remove use of __flash due to LTO issues (#15268) il y a 4 ans
feature_rgblight.md fb9a254a43 Retain brightness with lighting layers (#13025) il y a 5 ans
feature_sequencer.md 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) il y a 5 ans
feature_space_cadet.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) il y a 5 ans
feature_split_keyboard.md 12a8e59e9c [Docs] add sync options heading, update led indicators (#14441) il y a 5 ans
feature_st7565.md 37fba09021 ST7565 invert (#13237) il y a 5 ans
feature_stenography.md aa712b5e28 Merge remote-tracking branch 'origin/master' into develop il y a 4 ans
feature_swap_hands.md b56282756b [Docs] Clean up some code block languages (#14434) il y a 5 ans
feature_tap_dance.md f529580860 Basic keycode overhaul (#14726) il y a 4 ans
feature_terminal.md b23f6011c3 Remove build option firmware size impacts (#6947) il y a 6 ans
feature_thermal_printer.md 4c675a83ba Format keycode tables il y a 8 ans
feature_unicode.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) il y a 5 ans
feature_userspace.md 40bc5a8192 Enable CLI flashing via mdloader (#14729) il y a 4 ans
feature_velocikey.md 84ea77ead6 Remove `BOOTMAGIC_ENABLE = lite` option (#15002) il y a 4 ans
feature_wpm.md c9fd698711 Reimplements WPM feature to be smaller & precise (#13902) il y a 4 ans
flashing.md d5cb7de5e4 Change USBasp and bootloadHID bootloaders to lowercase (#14354) il y a 5 ans
flashing_bootloadhid.md b56282756b [Docs] Clean up some code block languages (#14434) il y a 5 ans
fuse.txt 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) il y a 5 ans
getting_started_docker.md b56282756b [Docs] Clean up some code block languages (#14434) il y a 5 ans
getting_started_github.md b2a186cf92 Purge uGFX. (#14720) il y a 4 ans
getting_started_introduction.md 09c7304bd9 [Docs] update git command and directory name of documents (#7619) il y a 6 ans
getting_started_make_guide.md 36d123e9c5 Add support for deferred executors. (#14859) il y a 4 ans
getting_started_vagrant.md b56282756b [Docs] Clean up some code block languages (#14434) il y a 5 ans
hand_wire.md 6fd9b2feba [Docs] Added information on soldering diodes in parallel (#13117) il y a 5 ans
hardware_avr.md b021c2f2c5 Port new_keyboard.sh to CLI (#13706) il y a 5 ans
hardware_drivers.md b2a186cf92 Purge uGFX. (#14720) il y a 4 ans
hardware_keyboard_guidelines.md b2a186cf92 Purge uGFX. (#14720) il y a 4 ans
how_a_matrix_works.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) il y a 5 ans
how_keyboards_work.md b56282756b [Docs] Clean up some code block languages (#14434) il y a 5 ans
i2c_driver.md bc1f5ef381 i2c_master: Add support for reading/writing to 16-bit registers (#14289) il y a 4 ans
index.html bbf0f65284 Simplify the visual flow of the getting started page (#11316) il y a 5 ans
internals_defines.md ae7284edb8 rename api docs to internals il y a 8 ans
internals_gpio_control.md 2728603fe6 Move tmk_core/common/<plat> (#13918) il y a 4 ans
internals_input_callback_reg.md ae7284edb8 rename api docs to internals il y a 8 ans
internals_midi_device.md ae7284edb8 rename api docs to internals il y a 8 ans
internals_midi_device_setup_process.md ae7284edb8 rename api docs to internals il y a 8 ans
internals_midi_util.md ae7284edb8 rename api docs to internals il y a 8 ans
internals_send_functions.md ae7284edb8 rename api docs to internals il y a 8 ans
internals_sysex_tools.md ae7284edb8 rename api docs to internals il y a 8 ans
isp_flashing_guide.md cc5a38e787 Rework ISP flashing guide (#14938) il y a 4 ans
keycodes.md 4bac5f53d8 New feature: `DYNAMIC_TAPPING_TERM_ENABLE` (#11036) il y a 4 ans
keycodes_basic.md f529580860 Basic keycode overhaul (#14726) il y a 4 ans
keycodes_magic.md 4c4f632378 Add a toggle key for GUI On/Off in Magic feature (#13830) il y a 5 ans
keycodes_us_ansi_shifted.md 40de65eac4 Backslash-escape pipe character in keycode lists (#7157) il y a 6 ans
keymap.md f529580860 Basic keycode overhaul (#14726) il y a 4 ans
mod_tap.md 57f63e43d8 [Docs] Correct logic of tap hold statement (#14992) il y a 4 ans
newbs.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) il y a 5 ans
newbs_building_firmware.md 54c58ea6de Add explicit id tags to externally linked headers il y a 6 ans
newbs_building_firmware_configurator.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) il y a 5 ans
newbs_flashing.md 0f516d9026 A few small typo fixes in docs (#12524) il y a 5 ans
newbs_getting_started.md 9b912416b4 [Docs] Add instructions to create keymap before proceeding (#14945) il y a 4 ans
newbs_git_best_practices.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) il y a 6 ans
newbs_git_resolving_merge_conflicts.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) il y a 6 ans
newbs_git_resynchronize_a_branch.md b56282756b [Docs] Clean up some code block languages (#14434) il y a 5 ans
newbs_git_using_your_master_branch.md 54c58ea6de Add explicit id tags to externally linked headers il y a 6 ans
newbs_learn_more_resources.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) il y a 5 ans
newbs_testing_debugging.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) il y a 5 ans
one_shot_keys.md fcce9f2a4f fix: Fix typo in documentation for one shot keys. ON_TOGG -> OS_TOGG (#13754) il y a 5 ans
other_eclipse.md cfbd9ba0e7 eclipse: recommend changing the default project make target (#12447) il y a 5 ans
other_vscode.md c71d67ba3f [Core] [Docs] Remove travis-ci references (#13916) il y a 5 ans
platformdev_chibios_earlyinit.md 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) il y a 5 ans
platformdev_selecting_arm_mcu.md 3afd2d81b8 Add documentation for selecting an Arm MCU (#9046) il y a 6 ans
power.txt bb53635f33 Trim trailing whitespace il y a 8 ans
pr_checklist.md 88fe5c16a5 Changelog 2021q4 (#15325) il y a 4 ans
proton_c_conversion.md 87291437bd Add board specific to Proton-C, with usual defaults turned on. (#10976) il y a 5 ans
qmk.css ccc87421e7 Some more tweaks to make everything look nice il y a 8 ans
qmk_custom_dark.css 4e8166750b Small tweaks to docs to make them more user friendly (#11518) il y a 5 ans
qmk_custom_light.css 4e8166750b Small tweaks to docs to make them more user friendly (#11518) il y a 5 ans
quantum_keycodes.md 54c58ea6de Add explicit id tags to externally linked headers il y a 6 ans
redirects.json d569f08771 Configuration system for CLI (#6708) il y a 7 ans
ref_functions.md a03aa301de Remove Full Bootmagic (#13846) il y a 5 ans
reference_configurator_support.md f529580860 Basic keycode overhaul (#14726) il y a 4 ans
reference_glossary.md 014aa0661e Fix Space Cadet md link (#14300) il y a 5 ans
reference_info_json.md b7a346600c [Docs] Clean up reference_info_json.md (#14806) il y a 4 ans
reference_keymap_extras.md fce12f0075 Rework keymap_extras docs (#13949) il y a 5 ans
serial_driver.md 0ae20e7457 Make solo half of split keyboards (more) usable. (#13523) il y a 5 ans
spi_driver.md 0e59827023 Merge remote-tracking branch 'upstream/master' into develop il y a 5 ans
squeezing_avr.md f4966a19d6 [Docs] Squeezing space out of AVR (#15243) il y a 4 ans
support.md e4823aadec Fix capitalisation of "GitHub" (#9184) il y a 6 ans
sw.js 303f425c6b Fix up info boxes. il y a 8 ans
syllabus.md f4966a19d6 [Docs] Squeezing space out of AVR (#15243) il y a 4 ans
tap_hold.md 4bac5f53d8 New feature: `DYNAMIC_TAPPING_TERM_ENABLE` (#11036) il y a 4 ans
translating.md 7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) il y a 6 ans
uart_driver.md 04b51e381e Update UART driver API (#14839) il y a 4 ans
understanding_qmk.md 4bac5f53d8 New feature: `DYNAMIC_TAPPING_TERM_ENABLE` (#11036) il y a 4 ans
unit_testing.md 1c0347b8b8 Remove SERIAL_LINK feature (#14727) il y a 4 ans
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores il y a 9 ans
ws2812_driver.md f889e26ed7 Documentation typo fix (#15298) il y a 4 ans

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.