Home Explore Help
Sign In
logic855
/
qmk_firmware
mirror of https://github.com/qmk/qmk_firmware.git
1
0
Fork 1
Files Issues 0 Wiki
Tree: 70c6b183df
Branches Tags
qmk_firmware
/
docs
Albert Y 70c6b183df [Docs] Refactor code examples (#18003) 4 years ago
..
ChangeLog d0af56da33 Breaking changes for 2022q2. (#17221) 4 years ago
gitbook 4580d3a730 RGB improvements (#1684) 9 years ago
internals 75544d9127 Move Doxygen docs to subdirectory (#16561) 4 years ago
ja e71f8f89d2 Merge remote-tracking branch 'origin/master' into develop 4 years ago
zh-cn 25ec68c408 Fix docs typo (#17254) 4 years ago
.nojekyll 9e5676650e Use docsfy to replace gitbook 8 years ago
CNAME 4d26137e2a Create CNAME 8 years ago
README.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 years ago
_langs.md 1c1e6fa47d Remove stale docs translations (#15737) 4 years ago
_summary.md 64acbcb42a [Docs] Building with GitHub Userspace (#16271) 4 years ago
adc_driver.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 5 years ago
api_development_environment.md 99850aabca Add API documentation 6 years ago
api_development_overview.md 99850aabca Add API documentation 6 years ago
api_docs.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) 4 years ago
api_overview.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 years ago
arm_debugging.md 52c18ef026 [Docs] fix docs (#7642) 6 years ago
audio_driver.md c0763363db [Docs] Fix tables in Audio driver document (#17780) 4 years ago
breaking_changes.md 89a5d5aea0 Fixup command sequencing for master/develop. (#17227) 4 years ago
breaking_changes_history.md de6360feca stub changelog 4 years ago
breaking_changes_instructions.md fced377ac0 2020 May 30 Breaking Changes Update (#9215) 6 years ago
chibios_upgrade_instructions.md 5da04fb45b Update to ChibiOS 20.3.4, support builds against trunk (#14208) 4 years ago
cli.md fcf150bd82 Streamline the macos install process 6 years ago
cli_commands.md 1f2b1dedcc Quantum Painter (#10174) 4 years ago
cli_configuration.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 years ago
cli_development.md da6d6ce2e1 Some docs improvements (#15845) 4 years ago
cli_tab_complete.md ee26d3e77f Add Zsh note for tab complete (#17226) 4 years ago
coding_conventions_c.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 years ago
coding_conventions_python.md fefd7fdc51 Refactor new-keyboard to be python3.7 compatible (#14707) 4 years ago
compatible_microcontrollers.md 15dab01e6a Inform people that things may not work. (#17391) 4 years ago
config_options.md 02655690f4 [Core] Add compile/make macro to core (#15959) 4 years ago
configurator_architecture.md 9a0118c603 Architecture documentation for Configurator and API (#13935) 5 years ago
configurator_default_keymaps.md f529580860 Basic keycode overhaul (#14726) 4 years ago
configurator_diagram.drawio 9a0118c603 Architecture documentation for Configurator and API (#13935) 5 years ago
configurator_diagram.svg 9a0118c603 Architecture documentation for Configurator and API (#13935) 5 years ago
configurator_step_by_step.md f6a7f4d4ac update the Chinese translation based on the latest English version (#14924) 4 years ago
configurator_troubleshooting.md d5f34c4810 Polish Configurator section 6 years ago
contributing.md f6a7f4d4ac update the Chinese translation based on the latest English version (#14924) 4 years ago
custom_matrix.md b56282756b [Docs] Clean up some code block languages (#14434) 4 years ago
custom_quantum_functions.md 3403f5813c Point out that deferred execution needs to be enabled in rules.mk (#16196) 4 years ago
data_driven_config.md ace0603f4f Change data driven "str" type to represent a quoted string literal (#16516) 4 years ago
documentation_best_practices.md 995464cb9c [Docs] fix file path (#9540) 6 years ago
documentation_templates.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 years ago
driver_installation_zadig.md e50867d52d [Core] Add support for RISC-V builds and GD32VF103 MCU (#12508) 4 years ago
easy_maker.md f6a7f4d4ac update the Chinese translation based on the latest English version (#14924) 4 years ago
eeprom_driver.md dd16d3cc7e eeprom_i2c driver: added EXTERNAL_EEPROM_WP_PIN configuration option. (#12617) 5 years ago
faq_build.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 years ago
faq_debug.md 3f1f60cbf9 doc/faq_debug: qmk cli can also be used to print debug messages (#15528) 4 years ago
faq_general.md d6701b3ac7 Fix typos and reword some sentences in FAQs (#11546) 5 years ago
faq_keymap.md d241e80533 Keymap FAQ updates (#17130) 4 years ago
faq_misc.md 84ea77ead6 Remove `BOOTMAGIC_ENABLE = lite` option (#15002) 4 years ago
feature_advanced_keycodes.md 8153b55e07 Add trailing parens to `get_oneshot_mods` in feature_advanced_keycodes.md (#17211) 4 years ago
feature_audio.md 4e3726bfe1 Fixup Audio startup and add to documents (#13606) 5 years ago
feature_auto_shift.md d9393b8684 Add Retro Shift (Auto Shift for Tap Hold via Retro Tapping) and Custom Auto Shifts (#11059) 4 years ago
feature_backlight.md b56282756b [Docs] Clean up some code block languages (#14434) 4 years ago
feature_bluetooth.md 7d685956cc Rename `AdafruitBLE` to `BluefruitLE` (#16127) 4 years ago
feature_bootmagic.md 9aaf4a5a9b Add split keyboard example for Bootmagic Lite (#16349) 4 years ago
feature_caps_word.md 68b16bba68 [Core] Add Caps Word feature to core (#16588) 4 years ago
feature_combo.md 21958a9343 New combo configuration options (#15083) 4 years ago
feature_command.md a03aa301de Remove Full Bootmagic (#13846) 5 years ago
feature_debounce_type.md 25713dc222 Add sym_defer_pr debouncer type (#14948) 4 years ago
feature_digitizer.md b56282756b [Docs] Clean up some code block languages (#14434) 4 years ago
feature_dip_switch.md 9d1c98c891 Added right vs left specific pin assignments for dip switch (#13074) 5 years ago
feature_dynamic_macros.md cdb69da86e Fix typo in docs/feature_dynamic_macros (#10085) 6 years ago
feature_encoders.md 70c6b183df [Docs] Refactor code examples (#18003) 4 years ago
feature_grave_esc.md b45a037c7e Rename some Quantum keycodes (#15968) 4 years ago
feature_haptic_feedback.md f090881aeb [Feature] Add support for multiple switchs/solenoids to Haptic Feedback engine (#15657) 4 years ago
feature_hd44780.md 9ee2effe8e HD44780 driver rework (#16370) 4 years ago
feature_joystick.md c05e8afe45 Joystick feature updates (#16732) 4 years ago
feature_key_lock.md 7f67504993 Added cancel_key_lock function (#15321) 4 years ago
feature_key_overrides.md f529580860 Basic keycode overhaul (#14726) 4 years ago
feature_layers.md 2728603fe6 Move tmk_core/common/<plat> (#13918) 4 years ago
feature_layouts.md b56282756b [Docs] Clean up some code block languages (#14434) 4 years ago
feature_leader_key.md b1f8622513 [Docs] Update feature_leader_key.md (#16344) 4 years ago
feature_led_indicators.md a5a4597311 Refine LED indicator documentation (#16304) 4 years ago
feature_led_matrix.md f296e1d1e2 [Docs] Align LED Matrix docs with RGB matrix docs (#17140) 4 years ago
feature_macros.md f52cc210b8 [Docs] feature_macro.md: minor formatting fix (#16205) 4 years ago
feature_midi.md 026d0e8bf1 Update feature_midi.md (#17390) 4 years ago
feature_mouse_keys.md 80dbdb2a61 Merge remote-tracking branch 'origin/master' into develop 4 years ago
feature_oled_driver.md 0f0e90971b [Docs] OLED documentation edits (#15977) 4 years ago
feature_pointing_device.md 690dc4bdaf Add support for multiple sensors to pmw3360 (#15996) 4 years ago
feature_programmable_button.md 83988597f4 Add Support for USB programmable buttons (#12950) 4 years ago
feature_ps2_mouse.md 84d5198ef9 Align PS/2 GPIO defines (#14745) 4 years ago
feature_rawhid.md b56282756b [Docs] Clean up some code block languages (#14434) 4 years ago
feature_rgb_matrix.md 70c6b183df [Docs] Refactor code examples (#18003) 4 years ago
feature_rgblight.md 5841c755ae rgblight: Add functions to stop blinking one or all but one layer (#16859) 4 years ago
feature_secure.md 2a3dd95229 Add basic secure docs (#17577) 4 years ago
feature_sequencer.md 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 years ago
feature_space_cadet.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 years ago
feature_split_keyboard.md fd01feae4b Add a note about using differents MCU family (#17416) 4 years ago
feature_st7565.md 37fba09021 ST7565 invert (#13237) 5 years ago
feature_stenography.md d5aab127d2 [Docs] Update Steno Keycode Table (#17155) 4 years ago
feature_swap_hands.md 8d5eacb7dd Add support for encoder mapping. (#13286) 4 years ago
feature_tap_dance.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) 4 years ago
feature_terminal.md b23f6011c3 Remove build option firmware size impacts (#6947) 6 years ago
feature_thermal_printer.md 4c675a83ba Format keycode tables 8 years ago
feature_unicode.md f634fddd34 Remove `send_unicode_hex_string()` (#16518) 4 years ago
feature_userspace.md 40bc5a8192 Enable CLI flashing via mdloader (#14729) 4 years ago
feature_velocikey.md 84ea77ead6 Remove `BOOTMAGIC_ENABLE = lite` option (#15002) 4 years ago
feature_wpm.md 0391801267 Fixes potential wpm sampling overflow, along with code comment fixes (#15277) 4 years ago
flash_driver.md 71c0b97bce Added external spi flash driver. (#15419) 4 years ago
flashing.md 25ec68c408 Fix docs typo (#17254) 4 years ago
flashing_bootloadhid.md b56282756b [Docs] Clean up some code block languages (#14434) 4 years ago
fuse.txt 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 years ago
getting_started_docker.md b56282756b [Docs] Clean up some code block languages (#14434) 4 years ago
getting_started_github.md b2a186cf92 Purge uGFX. (#14720) 4 years ago
getting_started_introduction.md 09c7304bd9 [Docs] update git command and directory name of documents (#7619) 6 years ago
getting_started_make_guide.md 36d123e9c5 Add support for deferred executors. (#14859) 4 years ago
getting_started_vagrant.md b56282756b [Docs] Clean up some code block languages (#14434) 4 years ago
gpio_control.md 75544d9127 Move Doxygen docs to subdirectory (#16561) 4 years ago
hand_wire.md 6fd9b2feba [Docs] Added information on soldering diodes in parallel (#13117) 5 years ago
hardware_drivers.md b2a186cf92 Purge uGFX. (#14720) 4 years ago
hardware_keyboard_guidelines.md 87199eb2f5 add 'info_config.h' into docs/hardware_keyboard_guidelines.md (#16247) 4 years ago
how_a_matrix_works.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 years ago
how_keyboards_work.md b85c224b7c docs: reflect systemd's change in language (#17322) 4 years ago
i2c_driver.md 81be7bb7b5 Fix i2c driver doc: Incorrect name (#16898) 4 years ago
index.html 94755308e0 Fix anchors with <code> in table of content (#15169) 4 years ago
isp_flashing_guide.md dde4120a1e ISP flashing guide: add instructions for flashing STM32duino bootloader (#16568) 4 years ago
keycodes.md 68b16bba68 [Core] Add Caps Word feature to core (#16588) 4 years ago
keycodes_basic.md f529580860 Basic keycode overhaul (#14726) 4 years ago
keycodes_magic.md 2726856cde Implement MAGIC_TOGGLE_CONTROL_CAPSLOCK (#15368) 4 years ago
keycodes_us_ansi_shifted.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) 4 years ago
keymap.md da6d6ce2e1 Some docs improvements (#15845) 4 years ago
mod_tap.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) 4 years ago
newbs.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 years ago
newbs_building_firmware.md d3584be431 [Docs] Update newbs_building_firmware.md (#16333) 4 years ago
newbs_building_firmware_configurator.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 years ago
newbs_building_firmware_workflow.md 64acbcb42a [Docs] Building with GitHub Userspace (#16271) 4 years ago
newbs_flashing.md 4e35697e1a Add note about qmk doctor in newbs_flashing.md (#15688) 4 years ago
newbs_getting_started.md 8fa7b62011 Attempt to discourage manual MSYS install for new users (#17556) 4 years ago
newbs_git_best_practices.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) 6 years ago
newbs_git_resolving_merge_conflicts.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) 6 years ago
newbs_git_resynchronize_a_branch.md b56282756b [Docs] Clean up some code block languages (#14434) 4 years ago
newbs_git_using_your_master_branch.md 54c58ea6de Add explicit id tags to externally linked headers 6 years ago
newbs_learn_more_resources.md 70c6b183df [Docs] Refactor code examples (#18003) 4 years ago
newbs_testing_debugging.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 years ago
one_shot_keys.md fcce9f2a4f fix: Fix typo in documentation for one shot keys. ON_TOGG -> OS_TOGG (#13754) 5 years ago
other_eclipse.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) 4 years ago
other_vscode.md 5f72d54299 Update other_vscode.md (#17317) 4 years ago
platformdev_blackpill_f411.md 8973835183 [Docs] Add information about WeAct Blackpill F411 (#16755) 4 years ago
platformdev_chibios_earlyinit.md 5fb93934d0 Fixes for bootloader refactor build failures (#15638) 4 years ago
platformdev_selecting_arm_mcu.md 3afd2d81b8 Add documentation for selecting an Arm MCU (#9046) 6 years ago
porting_your_keyboard_to_qmk.md 0d9a0d5d97 Align new-keyboard with recent schema updates (#16378) 4 years ago
power.txt bb53635f33 Trim trailing whitespace 8 years ago
pr_checklist.md 26954bbc28 [Docs] Add Encoder requirements to PR Checklist doc (#17634) 4 years ago
proton_c_conversion.md 75544d9127 Move Doxygen docs to subdirectory (#16561) 4 years ago
qmk.css ccc87421e7 Some more tweaks to make everything look nice 8 years ago
qmk_custom_dark.css 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 years ago
qmk_custom_light.css 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 years ago
quantum_keycodes.md 787a68948f [Core] Add Reboot keycode to core (#15990) 4 years ago
quantum_painter.md 1f2b1dedcc Quantum Painter (#10174) 4 years ago
quantum_painter_qff.md 1f2b1dedcc Quantum Painter (#10174) 4 years ago
quantum_painter_qgf.md 1f2b1dedcc Quantum Painter (#10174) 4 years ago
quantum_painter_rle.md 1f2b1dedcc Quantum Painter (#10174) 4 years ago
redirects.json d569f08771 Configuration system for CLI (#6708) 6 years ago
ref_functions.md 71472a1692 Update ref_functions.md (replaced deprecated `RESET`) (#17436) 4 years ago
reference_configurator_support.md f529580860 Basic keycode overhaul (#14726) 4 years ago
reference_glossary.md 014aa0661e Fix Space Cadet md link (#14300) 4 years ago
reference_info_json.md 2a3dd95229 Add basic secure docs (#17577) 4 years ago
reference_keymap_extras.md 4a8bd7b9a5 Rename keymap_extras headers for consistency (#16939) 4 years ago
serial_driver.md 0ae20e7457 Make solo half of split keyboards (more) usable. (#13523) 5 years ago
spi_driver.md 0e59827023 Merge remote-tracking branch 'upstream/master' into develop 5 years ago
squeezing_avr.md b1681fb6a1 [Core] Allow usage of AVRs minimal printf library (#16266) 4 years ago
support.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 years ago
sw.js 303f425c6b Fix up info boxes. 8 years ago
syllabus.md f4966a19d6 [Docs] Squeezing space out of AVR (#15243) 4 years ago
tap_hold.md 8f585153c4 Add GET_TAPPING_TERM macro to reduce duplicate code (#16681) 4 years ago
translating.md 7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) 6 years ago
uart_driver.md 04b51e381e Update UART driver API (#14839) 4 years ago
understanding_qmk.md da6d6ce2e1 Some docs improvements (#15845) 4 years ago
unit_testing.md 1c0347b8b8 Remove SERIAL_LINK feature (#14727) 4 years ago
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores 9 years ago
ws2812_driver.md f889e26ed7 Documentation typo fix (#15298) 4 years ago

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.