mh
/
qmk_firmware
mirror of https://github.com/qmk/qmk_firmware/
1
0
Fork 0
Code Issues 0 Projects 0 Releases 1.6k Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
22198 Commits
64 Branches
2.0 GiB
 
 
 
 
 
Tree: breakpoint
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'breakpoint'
${ noResults }
qmk_firmware/docs
Nick Brassel d0af56da33
Breaking changes for 2022q2. (#17221) 		1 year ago
..
ChangeLog Breaking changes for 2022q2. (#17221) 1 year ago
gitbook/images RGB improvements (#1684) 6 years ago
internals Move Doxygen docs to subdirectory (#16561) 2 years ago
ja Merge remote-tracking branch 'origin/master' into develop 2 years ago
zh-cn Merge remote-tracking branch 'origin/master' into develop 2 years ago
.nojekyll Use docsfy to replace gitbook 6 years ago
CNAME Create CNAME 6 years ago
README.md Small tweaks to docs to make them more user friendly (#11518) 3 years ago
_langs.md Remove stale docs translations (#15737) 2 years ago
_summary.md stub changelog 1 year ago
adc_driver.md 2021 May 29 Breaking Changes Update (#13034) 2 years ago
api_development_environment.md Add API documentation 4 years ago
api_development_overview.md Add API documentation 4 years ago
api_docs.md [Docs] Address some typos (also in moonlander matrix.c) (#16248) 2 years ago
api_overview.md [Docs] Use HTTPS for images and links where possible (#11695) 3 years ago
arm_debugging.md [Docs] fix docs (#7642) 4 years ago
audio_driver.md [Docs] Clean up some code block languages (#14434) 2 years ago
breaking_changes.md Breaking changes for 2022q2. (#17221) 1 year ago
breaking_changes_history.md stub changelog 1 year ago
breaking_changes_instructions.md 2020 May 30 Breaking Changes Update (#9215) 3 years ago
chibios_upgrade_instructions.md Update to ChibiOS 20.3.4, support builds against trunk (#14208) 2 years ago
cli.md Streamline the macos install process 3 years ago
cli_commands.md Quantum Painter (#10174) 2 years ago
cli_configuration.md Fix capitalisation of "GitHub" (#9184) 3 years ago
cli_development.md Some docs improvements (#15845) 2 years ago
cli_tab_complete.md Fix Typo in documentation (#14942) 2 years ago
coding_conventions_c.md [Docs] Use HTTPS for images and links where possible (#11695) 3 years ago
coding_conventions_python.md Refactor new-keyboard to be python3.7 compatible (#14707) 2 years ago
compatible_microcontrollers.md Added support for Wb32fq95 (#16871) 1 year ago
config_options.md [Core] Add compile/make macro to core (#15959) 2 years ago
configurator_architecture.md Architecture documentation for Configurator and API (#13935) 2 years ago
configurator_default_keymaps.md Basic keycode overhaul (#14726) 2 years ago
configurator_diagram.drawio Architecture documentation for Configurator and API (#13935) 2 years ago
configurator_diagram.svg Architecture documentation for Configurator and API (#13935) 2 years ago
configurator_step_by_step.md update the Chinese translation based on the latest English version (#14924) 2 years ago
configurator_troubleshooting.md Polish Configurator section 4 years ago
contributing.md update the Chinese translation based on the latest English version (#14924) 2 years ago
custom_matrix.md [Docs] Clean up some code block languages (#14434) 2 years ago
custom_quantum_functions.md Point out that deferred execution needs to be enabled in rules.mk (#16196) 2 years ago
data_driven_config.md Change data driven "str" type to represent a quoted string literal (#16516) 2 years ago
documentation_best_practices.md [Docs] fix file path (#9540) 3 years ago
documentation_templates.md [Docs] Use HTTPS for images and links where possible (#11695) 3 years ago
driver_installation_zadig.md [Core] Add support for RISC-V builds and GD32VF103 MCU (#12508) 2 years ago
easy_maker.md update the Chinese translation based on the latest English version (#14924) 2 years ago
eeprom_driver.md eeprom_i2c driver: added EXTERNAL_EEPROM_WP_PIN configuration option. (#12617) 2 years ago
faq_build.md [Docs] Use HTTPS for images and links where possible (#11695) 3 years ago
faq_debug.md doc/faq_debug: qmk cli can also be used to print debug messages (#15528) 2 years ago
faq_general.md Fix typos and reword some sentences in FAQs (#11546) 3 years ago
faq_keymap.md Keymap FAQ updates (#17130) 1 year ago
faq_misc.md Remove `BOOTMAGIC_ENABLE = lite` option (#15002) 2 years ago
feature_advanced_keycodes.md Additional documentation for GUI mod combo (#13266) 2 years ago
feature_audio.md Fixup Audio startup and add to documents (#13606) 2 years ago
feature_auto_shift.md Add Retro Shift (Auto Shift for Tap Hold via Retro Tapping) and Custom Auto Shifts (#11059) 2 years ago
feature_backlight.md [Docs] Clean up some code block languages (#14434) 2 years ago
feature_bluetooth.md Rename `AdafruitBLE` to `BluefruitLE` (#16127) 2 years ago
feature_bootmagic.md Add split keyboard example for Bootmagic Lite (#16349) 2 years ago
feature_caps_word.md [Core] Add Caps Word feature to core (#16588) 1 year ago
feature_combo.md New combo configuration options (#15083) 2 years ago
feature_command.md Remove Full Bootmagic (#13846) 2 years ago
feature_debounce_type.md Add sym_defer_pr debouncer type (#14948) 2 years ago
feature_digitizer.md [Docs] Clean up some code block languages (#14434) 2 years ago
feature_dip_switch.md Added right vs left specific pin assignments for dip switch (#13074) 2 years ago
feature_dynamic_macros.md Fix typo in docs/feature_dynamic_macros (#10085) 3 years ago
feature_encoders.md Breaking changes for 2022q2. (#17221) 1 year ago
feature_grave_esc.md Rename some Quantum keycodes (#15968) 2 years ago
feature_haptic_feedback.md [Feature] Add support for multiple switchs/solenoids to Haptic Feedback engine (#15657) 1 year ago
feature_hd44780.md HD44780 driver rework (#16370) 2 years ago
feature_joystick.md Joystick feature updates (#16732) 2 years ago
feature_key_lock.md Added cancel_key_lock function (#15321) 2 years ago
feature_key_overrides.md Basic keycode overhaul (#14726) 2 years ago
feature_layers.md Move tmk_core/common/<plat> (#13918) 2 years ago
feature_layouts.md [Docs] Clean up some code block languages (#14434) 2 years ago
feature_leader_key.md [Docs] Update feature_leader_key.md (#16344) 2 years ago
feature_led_indicators.md Refine LED indicator documentation (#16304) 2 years ago
feature_led_matrix.md [Docs] Align LED Matrix docs with RGB matrix docs (#17140) 1 year ago
feature_macros.md [Docs] feature_macro.md: minor formatting fix (#16205) 2 years ago
feature_midi.md Move Doxygen docs to subdirectory (#16561) 2 years ago
feature_mouse_keys.md Merge remote-tracking branch 'origin/master' into develop 2 years ago
feature_oled_driver.md [Docs] OLED documentation edits (#15977) 2 years ago
feature_pointing_device.md Add support for multiple sensors to pmw3360 (#15996) 2 years ago
feature_programmable_button.md Add Support for USB programmable buttons (#12950) 2 years ago
feature_ps2_mouse.md Align PS/2 GPIO defines (#14745) 2 years ago
feature_rawhid.md [Docs] Clean up some code block languages (#14434) 2 years ago
feature_rgb_matrix.md Merge remote-tracking branch 'origin/master' into develop 1 year ago
feature_rgblight.md rgblight: Add functions to stop blinking one or all but one layer (#16859) 2 years ago
feature_sequencer.md Ensure single newline at EOF for core files (#11310) 3 years ago
feature_space_cadet.md [Docs] Use HTTPS for images and links where possible (#11695) 3 years ago
feature_split_keyboard.md Merge remote-tracking branch 'origin/master' into develop 2 years ago
feature_st7565.md ST7565 invert (#13237) 2 years ago
feature_stenography.md [Docs] Update Steno Keycode Table (#17155) 1 year ago
feature_swap_hands.md Add support for encoder mapping. (#13286) 2 years ago
feature_tap_dance.md [Docs] Address some typos (also in moonlander matrix.c) (#16248) 2 years ago
feature_terminal.md Remove build option firmware size impacts (#6947) 4 years ago
feature_thermal_printer.md Format keycode tables 6 years ago
feature_unicode.md Remove `send_unicode_hex_string()` (#16518) 2 years ago
feature_userspace.md Enable CLI flashing via mdloader (#14729) 2 years ago
feature_velocikey.md Remove `BOOTMAGIC_ENABLE = lite` option (#15002) 2 years ago
feature_wpm.md Fixes potential wpm sampling overflow, along with code comment fixes (#15277) 2 years ago
flash_driver.md Added external spi flash driver. (#15419) 2 years ago
flashing.md Add flash target for UF2 bootloaders (#16525) 2 years ago
flashing_bootloadhid.md [Docs] Clean up some code block languages (#14434) 2 years ago
fuse.txt Ensure single newline at EOF for core files (#11310) 3 years ago
getting_started_docker.md [Docs] Clean up some code block languages (#14434) 2 years ago
getting_started_github.md Purge uGFX. (#14720) 2 years ago
getting_started_introduction.md [Docs] update git command and directory name of documents (#7619) 4 years ago
getting_started_make_guide.md Add support for deferred executors. (#14859) 2 years ago
getting_started_vagrant.md [Docs] Clean up some code block languages (#14434) 2 years ago
gpio_control.md Move Doxygen docs to subdirectory (#16561) 2 years ago
hand_wire.md [Docs] Added information on soldering diodes in parallel (#13117) 2 years ago
hardware_drivers.md Purge uGFX. (#14720) 2 years ago
hardware_keyboard_guidelines.md add 'info_config.h' into docs/hardware_keyboard_guidelines.md (#16247) 2 years ago
how_a_matrix_works.md [Docs] Use HTTPS for images and links where possible (#11695) 3 years ago
how_keyboards_work.md [Docs] Clean up some code block languages (#14434) 2 years ago
i2c_driver.md Fix i2c driver doc: Incorrect name (#16898) 2 years ago
index.html Fix anchors with <code> in table of content (#15169) 1 year ago
isp_flashing_guide.md ISP flashing guide: add instructions for flashing STM32duino bootloader (#16568) 2 years ago
keycodes.md [Core] Add Caps Word feature to core (#16588) 1 year ago
keycodes_basic.md Basic keycode overhaul (#14726) 2 years ago
keycodes_magic.md Implement MAGIC_TOGGLE_CONTROL_CAPSLOCK (#15368) 2 years ago
keycodes_us_ansi_shifted.md [Docs] Address some typos (also in moonlander matrix.c) (#16248) 2 years ago
keymap.md Some docs improvements (#15845) 2 years ago
mod_tap.md [Docs] Address some typos (also in moonlander matrix.c) (#16248) 2 years ago
newbs.md [Docs] Use HTTPS for images and links where possible (#11695) 3 years ago
newbs_building_firmware.md [Docs] Update newbs_building_firmware.md (#16333) 2 years ago
newbs_building_firmware_configurator.md Small tweaks to docs to make them more user friendly (#11518) 3 years ago
newbs_flashing.md [Docs] newbs_flashing.md: add link to build environment section (#15654) 2 years ago
newbs_getting_started.md Recommend pillow as part of manual MSYS install (#17133) 1 year ago
newbs_git_best_practices.md [Docs] Restructure of Git Best Practices doc (#7231) 4 years ago
newbs_git_resolving_merge_conflicts.md [Docs] Restructure of Git Best Practices doc (#7231) 4 years ago
newbs_git_resynchronize_a_branch.md [Docs] Clean up some code block languages (#14434) 2 years ago
newbs_git_using_your_master_branch.md Add explicit id tags to externally linked headers 4 years ago
newbs_learn_more_resources.md Add Atom editor suggestion (#15969) 2 years ago
newbs_testing_debugging.md Small tweaks to docs to make them more user friendly (#11518) 3 years ago
one_shot_keys.md fix: Fix typo in documentation for one shot keys. ON_TOGG -> OS_TOGG (#13754) 2 years ago
other_eclipse.md [Docs] Address some typos (also in moonlander matrix.c) (#16248) 2 years ago
other_vscode.md [Docs] Address some typos (also in moonlander matrix.c) (#16248) 2 years ago
platformdev_chibios_earlyinit.md Fixes for bootloader refactor build failures (#15638) 2 years ago
platformdev_selecting_arm_mcu.md Add documentation for selecting an Arm MCU (#9046) 3 years ago
porting_your_keyboard_to_qmk.md Align new-keyboard with recent schema updates (#16378) 2 years ago
power.txt Trim trailing whitespace 6 years ago
pr_checklist.md Update pr_checklist.md (#17122) 1 year ago
proton_c_conversion.md Move Doxygen docs to subdirectory (#16561) 2 years ago
qmk.css Some more tweaks to make everything look nice 6 years ago
qmk_custom_dark.css Small tweaks to docs to make them more user friendly (#11518) 3 years ago
qmk_custom_light.css Small tweaks to docs to make them more user friendly (#11518) 3 years ago
quantum_keycodes.md [Core] Add Reboot keycode to core (#15990) 1 year ago
quantum_painter.md Quantum Painter (#10174) 2 years ago
quantum_painter_qff.md Quantum Painter (#10174) 2 years ago
quantum_painter_qgf.md Quantum Painter (#10174) 2 years ago
quantum_painter_rle.md Quantum Painter (#10174) 2 years ago
redirects.json Configuration system for CLI (#6708) 4 years ago
ref_functions.md Fix typo in docs/ref_functions.md (#16690) 2 years ago
reference_configurator_support.md Basic keycode overhaul (#14726) 2 years ago
reference_glossary.md Fix Space Cadet md link (#14300) 2 years ago
reference_info_json.md Fix in-page links in reference_info_json.md (#16487) 2 years ago
reference_keymap_extras.md Rename keymap_extras headers for consistency (#16939) 1 year ago
serial_driver.md Make solo half of split keyboards (more) usable. (#13523) 2 years ago
spi_driver.md Merge remote-tracking branch 'upstream/master' into develop 3 years ago
squeezing_avr.md [Core] Allow usage of AVRs minimal printf library (#16266) 2 years ago
support.md Fix capitalisation of "GitHub" (#9184) 3 years ago
sw.js Fix up info boxes. 6 years ago
syllabus.md [Docs] Squeezing space out of AVR (#15243) 2 years ago
tap_hold.md Add GET_TAPPING_TERM macro to reduce duplicate code (#16681) 2 years ago
translating.md Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) 4 years ago
uart_driver.md Update UART driver API (#14839) 2 years ago
understanding_qmk.md Some docs improvements (#15845) 2 years ago
unit_testing.md Remove SERIAL_LINK feature (#14727) 2 years ago
usb_nkro.txt convert docs to lowercase and underscores 6 years ago
ws2812_driver.md Documentation typo fix (#15298) 2 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
User friendly graphical interfaces, no programming knowledge required.

?> Advanced Use The Source
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.