1
0
Joel Challis 40e33d03a8 Recommend pillow as part of manual MSYS install (#17133) 4 жил өмнө
..
ChangeLog cf31355f08 Changelog 2022q1 (#16380) 4 жил өмнө
gitbook 4580d3a730 RGB improvements (#1684) 9 жил өмнө
internals 75544d9127 Move Doxygen docs to subdirectory (#16561) 4 жил өмнө
ja e71f8f89d2 Merge remote-tracking branch 'origin/master' into develop 4 жил өмнө
zh-cn 05ab7453ec Merge remote-tracking branch 'origin/master' into develop 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 1c1e6fa47d Remove stale docs translations (#15737) 4 жил өмнө
_summary.md 68b16bba68 [Core] Add Caps Word feature to core (#16588) 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 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) 4 жил өмнө
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 cf31355f08 Changelog 2022q1 (#16380) 4 жил өмнө
breaking_changes_history.md cf31355f08 Changelog 2022q1 (#16380) 4 жил өмнө
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 1f2b1dedcc Quantum Painter (#10174) 4 жил өмнө
cli_configuration.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 жил өмнө
cli_development.md da6d6ce2e1 Some docs improvements (#15845) 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 77062e9a36 Add L432, L442. (#16016) 4 жил өмнө
config_options.md 02655690f4 [Core] Add compile/make macro to core (#15959) 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 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 b56282756b [Docs] Clean up some code block languages (#14434) 4 жил өмнө
custom_quantum_functions.md 3403f5813c Point out that deferred execution needs to be enabled in rules.mk (#16196) 4 жил өмнө
data_driven_config.md ace0603f4f Change data driven "str" type to represent a quoted string literal (#16516) 4 жил өмнө
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 f6a7f4d4ac update the Chinese translation based on the latest English version (#14924) 4 жил өмнө
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 3f1f60cbf9 doc/faq_debug: qmk cli can also be used to print debug messages (#15528) 4 жил өмнө
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 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 7d685956cc Rename `AdafruitBLE` to `BluefruitLE` (#16127) 4 жил өмнө
feature_bootmagic.md 9aaf4a5a9b Add split keyboard example for Bootmagic Lite (#16349) 4 жил өмнө
feature_caps_word.md 68b16bba68 [Core] Add Caps Word feature to core (#16588) 4 жил өмнө
feature_combo.md 21958a9343 New combo configuration options (#15083) 4 жил өмнө
feature_command.md a03aa301de Remove Full Bootmagic (#13846) 5 жил өмнө
feature_debounce_type.md 25713dc222 Add sym_defer_pr debouncer type (#14948) 4 жил өмнө
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 8d5eacb7dd Add support for encoder mapping. (#13286) 4 жил өмнө
feature_grave_esc.md b45a037c7e Rename some Quantum keycodes (#15968) 4 жил өмнө
feature_haptic_feedback.md f090881aeb [Feature] Add support for multiple switchs/solenoids to Haptic Feedback engine (#15657) 4 жил өмнө
feature_hd44780.md 9ee2effe8e HD44780 driver rework (#16370) 4 жил өмнө
feature_joystick.md c05e8afe45 Joystick feature updates (#16732) 4 жил өмнө
feature_key_lock.md 7f67504993 Added cancel_key_lock function (#15321) 4 жил өмнө
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 b1f8622513 [Docs] Update feature_leader_key.md (#16344) 4 жил өмнө
feature_led_indicators.md a5a4597311 Refine LED indicator documentation (#16304) 4 жил өмнө
feature_led_matrix.md 0452ad9479 Add RGB matrix & LED Matrix support for IS31FL3742A, IS31FL3743A, IS31FL3745, IS31FL3746A (#14989) 4 жил өмнө
feature_macros.md f52cc210b8 [Docs] feature_macro.md: minor formatting fix (#16205) 4 жил өмнө
feature_midi.md 75544d9127 Move Doxygen docs to subdirectory (#16561) 4 жил өмнө
feature_mouse_keys.md 80dbdb2a61 Merge remote-tracking branch 'origin/master' into develop 4 жил өмнө
feature_oled_driver.md 0f0e90971b [Docs] OLED documentation edits (#15977) 4 жил өмнө
feature_pointing_device.md 690dc4bdaf Add support for multiple sensors to pmw3360 (#15996) 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 e5918cf968 Heatmap incorrect matrix effect workaround (#16315) 4 жил өмнө
feature_rgblight.md 5841c755ae rgblight: Add functions to stop blinking one or all but one layer (#16859) 4 жил өмнө
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 43d18321e3 Merge remote-tracking branch 'origin/master' into develop 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 8d5eacb7dd Add support for encoder mapping. (#13286) 4 жил өмнө
feature_tap_dance.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) 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 f634fddd34 Remove `send_unicode_hex_string()` (#16518) 4 жил өмнө
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 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 2bface8f89 Add flash target for UF2 bootloaders (#16525) 4 жил өмнө
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 жил өмнө
gpio_control.md 75544d9127 Move Doxygen docs to subdirectory (#16561) 4 жил өмнө
hand_wire.md 6fd9b2feba [Docs] Added information on soldering diodes in parallel (#13117) 5 жил өмнө
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 b56282756b [Docs] Clean up some code block languages (#14434) 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 68b16bba68 [Core] Add Caps Word feature to core (#16588) 4 жил өмнө
keycodes_basic.md f529580860 Basic keycode overhaul (#14726) 4 жил өмнө
keycodes_magic.md 2726856cde Implement MAGIC_TOGGLE_CONTROL_CAPSLOCK (#15368) 4 жил өмнө
keycodes_us_ansi_shifted.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) 4 жил өмнө
keymap.md da6d6ce2e1 Some docs improvements (#15845) 4 жил өмнө
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 d3584be431 [Docs] Update newbs_building_firmware.md (#16333) 4 жил өмнө
newbs_building_firmware_configurator.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 жил өмнө
newbs_flashing.md 069ef7eb9e [Docs] newbs_flashing.md: add link to build environment section (#15654) 4 жил өмнө
newbs_getting_started.md 40e33d03a8 Recommend pillow as part of manual MSYS install (#17133) 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 8901c9eca1 Add Atom editor suggestion (#15969) 4 жил өмнө
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 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) 4 жил өмнө
other_vscode.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) 4 жил өмнө
platformdev_chibios_earlyinit.md 5fb93934d0 Fixes for bootloader refactor build failures (#15638) 4 жил өмнө
platformdev_selecting_arm_mcu.md 3afd2d81b8 Add documentation for selecting an Arm MCU (#9046) 6 жил өмнө
porting_your_keyboard_to_qmk.md 0d9a0d5d97 Align new-keyboard with recent schema updates (#16378) 4 жил өмнө
power.txt bb53635f33 Trim trailing whitespace 8 жил өмнө
pr_checklist.md dba5b730a3 Update pr_checklist.md (#17122) 4 жил өмнө
proton_c_conversion.md 75544d9127 Move Doxygen docs to subdirectory (#16561) 4 жил өмнө
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 787a68948f [Core] Add Reboot keycode to core (#15990) 4 жил өмнө
quantum_painter.md 1f2b1dedcc Quantum Painter (#10174) 4 жил өмнө
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 3502bbbd16 Fix typo in docs/ref_functions.md (#16690) 4 жил өмнө
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 8014fb14b6 Fix in-page links in reference_info_json.md (#16487) 4 жил өмнө
reference_keymap_extras.md 4a8bd7b9a5 Rename keymap_extras headers for consistency (#16939) 4 жил өмнө
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 b1681fb6a1 [Core] Allow usage of AVRs minimal printf library (#16266) 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 8f585153c4 Add GET_TAPPING_TERM macro to reduce duplicate code (#16681) 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 da6d6ce2e1 Some docs improvements (#15845) 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 f889e26ed7 Documentation typo fix (#15298) 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.