sporq/qmk-firmware

History

QMK Bot d89f7f02b0 Merge remote-tracking branch 'origin/master' into develop

2022-10-13 19:02:55 +00:00

..

2022q3 Changelog. (#18180 )

2022-08-28 14:20:52 +10:00

…

Move Doxygen docs to subdirectory (#16561 )

2022-03-07 11:22:22 +00:00

Merge remote-tracking branch 'origin/master' into develop

2022-09-15 00:04:32 +00:00

[Docs] RESET -> QK_BOOT (#18365 )

2022-09-15 01:03:55 +01:00

_langs.md

Remove stale docs translations (#15737 )

2022-01-04 18:11:24 -08:00

_summary.md

Merge remote-tracking branch 'origin/master' into develop

2022-09-19 01:20:51 +00:00

.nojekyll

…

adc_driver.md

2021 May 29 Breaking Changes Update (#13034 )

2021-05-29 14:38:50 -07:00

api_development_environment.md

Add API documentation

2020-03-05 16:00:10 -08:00

api_development_overview.md

Add API documentation

2020-03-05 16:00:10 -08:00

api_docs.md

Remove legacy international keycodes (#18588 )

2022-10-09 14:51:09 +11:00

api_overview.md

[Docs] Use HTTPS for images and links where possible (#11695 )

2021-01-30 22:00:56 +11:00

arm_debugging.md

…

audio_driver.md

[Docs] Fix tables in Audio driver document (#17780 )

2022-07-25 00:00:51 +01:00

breaking_changes_history.md

2022q3 Changelog. (#18180 )

2022-08-28 14:20:52 +10:00

breaking_changes_instructions.md

2020 May 30 Breaking Changes Update (#9215 )

2020-05-30 13:14:59 -07:00

breaking_changes.md

2022q3 Changelog. (#18180 )

2022-08-28 14:20:52 +10:00

chibios_upgrade_instructions.md

Update to ChibiOS 20.3.4, support builds against trunk (#14208 )

2021-11-03 08:26:40 +11:00

cli_commands.md

docs: some typos (#18582 )

2022-10-05 17:32:07 +01:00

cli_configuration.md

Fix capitalisation of "GitHub" (#9184 )

2020-05-25 19:43:14 -07:00

cli_development.md

docs: some typos (#18582 )

2022-10-05 17:32:07 +01:00

cli_tab_complete.md

Add Zsh note for tab complete (#17226 )

2022-07-02 21:59:59 +10:00

cli.md

Streamline the macos install process

2020-05-18 22:46:33 -07:00

CNAME

…

coding_conventions_c.md

docs: some typos (#18582 )

2022-10-05 17:32:07 +01:00

coding_conventions_python.md

docs: some typos (#18582 )

2022-10-05 17:32:07 +01:00

compatible_microcontrollers.md

Tentative Teensy 3.5 support (#14420 )

2022-07-03 00:12:45 +10:00

config_options.md

Implement split comms watchdog (#18599 )

2022-10-06 20:52:42 +11:00

configurator_architecture.md

Architecture documentation for Configurator and API (#13935 )

2021-08-10 07:47:53 -07:00

configurator_default_keymaps.md

[Docs] RESET -> QK_BOOT (#18365 )

2022-09-15 01:03:55 +01:00

configurator_diagram.drawio

Architecture documentation for Configurator and API (#13935 )

2021-08-10 07:47:53 -07:00

configurator_diagram.svg

Architecture documentation for Configurator and API (#13935 )

2021-08-10 07:47:53 -07:00

configurator_step_by_step.md

update the Chinese translation based on the latest English version (#14924 )

2022-01-18 18:24:02 +00:00

configurator_troubleshooting.md

Polish Configurator section

2020-03-05 16:00:10 -08:00

contributing.md

update the Chinese translation based on the latest English version (#14924 )

2022-01-18 18:24:02 +00:00

custom_matrix.md

Make debounce() signal changes in the cooked matrix as return value (#17554 )

2022-07-07 10:00:40 +02:00

custom_quantum_functions.md

[Docs] Extract 'Layer Change Code' and EEPROM (#18174 )

2022-09-19 02:20:22 +01:00

data_driven_config.md

[Docs] Fix typo in data driven config docs (#18095 )

2022-08-18 18:18:51 -07:00

documentation_best_practices.md

[Docs] fix file path (#9540 )

2020-06-25 15:58:36 +10:00

documentation_templates.md

[Docs] Use HTTPS for images and links where possible (#11695 )

2021-01-30 22:00:56 +11:00

driver_installation_zadig.md

[Docs] RESET -> QK_BOOT (#18365 )

2022-09-15 01:03:55 +01:00

easy_maker.md

update the Chinese translation based on the latest English version (#14924 )

2022-01-18 18:24:02 +00:00

eeprom_driver.md

RP2040 emulated EEPROM. (#17519 )

2022-07-02 15:18:50 +10:00

faq_build.md

[Docs] Use HTTPS for images and links where possible (#11695 )

2021-01-30 22:00:56 +11:00

faq_debug.md

[Docs] Add a note about the print function. (#17737 )

2022-10-04 19:16:11 -07:00

faq_general.md

Fix typos and reword some sentences in FAQs (#11546 )

2021-01-23 13:41:29 -08:00

faq_keymap.md

Keymap FAQ updates (#17130 )

2022-05-18 04:48:59 +10:00

faq_misc.md

[Docs] RESET -> QK_BOOT (#18365 )

2022-09-15 01:03:55 +01:00

feature_advanced_keycodes.md

[Docs] Extract 'Layer Change Code' and EEPROM (#18174 )

2022-09-19 02:20:22 +01:00

feature_audio.md

[Docs] RESET -> QK_BOOT (#18365 )

2022-09-15 01:03:55 +01:00

feature_auto_shift.md

Add Retro Shift (Auto Shift for Tap Hold via Retro Tapping) and Custom Auto Shifts (#11059 )

2021-11-25 23:12:14 +11:00

feature_autocorrect.md

[Core] Add getreuer's Autocorrect feature to core (#15699 )

2022-09-17 17:50:54 +10:00

feature_backlight.md

[Docs] Clean up some code block languages (#14434 )

2021-09-14 13:16:24 +01:00

feature_bluetooth.md

Rename AdafruitBLE to BluefruitLE (#16127 )

2022-01-30 17:29:42 +00:00

feature_bootmagic.md

Add split keyboard example for Bootmagic Lite (#16349 )

2022-03-15 01:31:17 -07:00

feature_caps_word.md

[Docs] Clarify CAPS_WORD behaviors (#18137 )

2022-10-03 19:17:08 -07:00

feature_combo.md

Use a macro to compute the size of arrays at compile time (#18044 )

2022-08-30 10:20:04 +02:00

feature_command.md

Remove Full Bootmagic (#13846 )

2021-08-06 23:59:56 -07:00

feature_converters.md

Add Elite-C to converters (#18309 )

2022-09-18 20:30:27 +01:00

feature_debounce_type.md

Add sym_defer_pr debouncer type (#14948 )

2021-12-27 13:44:56 +11:00

feature_digitizer.md

[Docs] Clean up some code block languages (#14434 )

2021-09-14 13:16:24 +01:00

feature_dip_switch.md

Added right vs left specific pin assignments for dip switch (#13074 )

2021-08-19 18:39:15 +01:00

feature_dynamic_macros.md

Added Wait time to sending each Keys for Dynamic Macros function (#16800 )

2022-07-02 21:48:26 +10:00

feature_eeprom.md

[Docs] Extract 'Layer Change Code' and EEPROM (#18174 )

2022-09-19 02:20:22 +01:00

feature_encoders.md

Resolve conflict merging master to develop (#18297 )

2022-09-06 17:42:43 -04:00

feature_grave_esc.md

Rename some Quantum keycodes (#15968 )

2022-01-22 03:34:15 +00:00

feature_haptic_feedback.md

[Feature] Add support for multiple switchs/solenoids to Haptic Feedback engine (#15657 )

2022-05-15 21:24:35 +10:00

feature_hd44780.md

HD44780 driver rework (#16370 )

2022-03-19 17:57:22 +11:00

feature_joystick.md

Further refactoring of joystick feature (#18437 )

2022-09-27 18:37:13 +10:00

feature_key_lock.md

Added cancel_key_lock function (#15321 )

2021-11-29 00:17:07 -08:00

feature_key_overrides.md

Basic keycode overhaul (#14726 )

2021-11-03 22:22:17 -07:00

feature_layers.md

[Docs] Extract 'Layer Change Code' and EEPROM (#18174 )

2022-09-19 02:20:22 +01:00

feature_layouts.md

[Docs] Clean up some code block languages (#14434 )

2021-09-14 13:16:24 +01:00

feature_leader_key.md

[Docs] Update feature_leader_key.md (#16344 )

2022-02-21 09:08:36 -08:00

feature_led_indicators.md

quantum: led: split out led_update_ports() for customization of led behaviour (#14452 )

2022-10-06 21:24:41 +11:00

feature_led_matrix.md

Fix Per Key LED Indicator Callbacks (#18450 )

2022-10-04 15:24:22 -07:00

feature_macros.md

docs: some typos (#18582 )

2022-10-05 17:32:07 +01:00

feature_midi.md

Update feature_midi.md (#17390 )

2022-06-14 11:12:52 +01:00

feature_mouse_keys.md

[Core] Mouse key kinetic mode fix (#17176 )

2022-06-19 11:15:55 -07:00

feature_oled_driver.md

docs: some typos (#18582 )

2022-10-05 17:32:07 +01:00

feature_pointing_device.md

Allow Active High for Pointing Device Motion Pin (#18404 )

2022-09-24 08:44:14 -07:00

feature_programmable_button.md

Add Support for USB programmable buttons (#12950 )

2021-09-15 08:40:22 -07:00

feature_ps2_mouse.md

[Core] Rework PS/2 driver selection (#17892 )

2022-08-31 09:16:07 +02:00

feature_rawhid.md

[Docs] Clean up some code block languages (#14434 )

2021-09-14 13:16:24 +01:00

feature_rgb_matrix.md

Fix boundary in RGB_MATRIX_INDICATOR_SET_COLOR (#18650 )

2022-10-11 11:33:02 -07:00

feature_rgblight.md

Add deprecated check for RGBLIGHT_ANIMATIONS (#17832 )

2022-08-04 11:05:53 -07:00

feature_secure.md

Add basic secure docs (#17577 )

2022-07-13 00:06:19 +01:00

feature_send_string.md

Feature-ify Send String (#17275 )

2022-07-02 22:10:08 +10:00

feature_sequencer.md

Ensure single newline at EOF for core files (#11310 )

2020-12-28 04:36:32 +11:00

feature_space_cadet.md

[Docs] Use HTTPS for images and links where possible (#11695 )

2021-01-30 22:00:56 +11:00

feature_split_keyboard.md

Implement split comms watchdog (#18599 )

2022-10-06 20:52:42 +11:00

feature_st7565.md

ST7565 invert (#13237 )

2021-06-19 18:51:35 +10:00

feature_stenography.md

Rename postprocess_steno_user → post_process_steno_user (#17823 )

2022-07-28 21:51:01 -07:00

feature_swap_hands.md

Add support for encoder mapping. (#13286 )

2022-03-09 19:29:00 +11:00

feature_tap_dance.md

Update feature_tap_dance.md (#18509 )

2022-09-28 20:22:59 +01:00

feature_thermal_printer.md

…

feature_unicode.md

Remove UNICODE_KEY_OSX and UC_OSX (#18290 )

2022-09-06 18:07:08 +01:00

feature_userspace.md

Enable CLI flashing via mdloader (#14729 )

2021-10-15 22:07:33 +01:00

feature_velocikey.md

Remove BOOTMAGIC_ENABLE = lite option (#15002 )

2021-11-05 08:18:09 +11:00

feature_wpm.md

Fixes potential wpm sampling overflow, along with code comment fixes (#15277 )

2021-12-27 11:52:56 +11:00

flash_driver.md

Added external spi flash driver. (#15419 )

2022-02-11 20:26:16 +00:00

flashing_bootloadhid.md

[Docs] RESET -> QK_BOOT (#18365 )

2022-09-15 01:03:55 +01:00

flashing.md

[Docs] RESET -> QK_BOOT (#18365 )

2022-09-15 01:03:55 +01:00

fuse.txt

Ensure single newline at EOF for core files (#11310 )

2020-12-28 04:36:32 +11:00

getting_started_docker.md

[Docs] Clean up some code block languages (#14434 )

2021-09-14 13:16:24 +01:00

getting_started_github.md

Purge uGFX. (#14720 )

2021-10-07 10:57:48 +11:00

getting_started_introduction.md

…

getting_started_make_guide.md

Add support for deferred executors. (#14859 )

2021-11-15 18:21:09 +00:00

getting_started_vagrant.md

[Docs] Clean up some code block languages (#14434 )

2021-09-14 13:16:24 +01:00

gpio_control.md

Move Doxygen docs to subdirectory (#16561 )

2022-03-07 11:22:22 +00:00

hand_wire.md

Improve importer workflow (#17707 )

2022-08-13 14:39:56 +01:00

hardware_drivers.md

Purge uGFX. (#14720 )

2021-10-07 10:57:48 +11:00

hardware_keyboard_guidelines.md

add 'info_config.h' into docs/hardware_keyboard_guidelines.md (#16247 )

2022-02-06 17:37:59 +00:00

how_a_matrix_works.md

[Docs] Use HTTPS for images and links where possible (#11695 )

2021-01-30 22:00:56 +11:00

how_keyboards_work.md

docs: reflect systemd's change in language (#17322 )

2022-06-06 23:29:59 +01:00

i2c_driver.md

Fix i2c driver doc: Incorrect name (#16898 )

2022-04-20 18:10:20 +01:00

index.html

Fix anchors with <code> in table of content (#15169 )

2022-05-14 23:08:32 +01:00

isp_flashing_guide.md

ISP flashing guide: add instructions for flashing STM32duino bootloader (#16568 )

2022-03-13 23:55:47 +00:00

keycodes_basic.md

Chromeos keycodes (#18212 )

2022-09-17 15:48:09 +10:00

keycodes_magic.md

PoC: Swap Escape and Caps (#16336 )

2022-07-02 22:08:48 +10:00

keycodes_us_ansi_shifted.md

[Docs] Address some typos (also in moonlander matrix.c) (#16248 )

2022-02-06 17:36:44 +00:00

keycodes.md

Chromeos keycodes (#18212 )

2022-09-17 15:48:09 +10:00

keymap.md

Remove legacy international keycodes (#18588 )

2022-10-09 14:51:09 +11:00

mod_tap.md

[Docs] Address some typos (also in moonlander matrix.c) (#16248 )

2022-02-06 17:36:44 +00:00

newbs_building_firmware_configurator.md

Small tweaks to docs to make them more user friendly (#11518 )

2021-01-20 18:46:01 +00:00

newbs_building_firmware_workflow.md

[Docs] Building with GitHub Userspace (#16271 )

2022-08-06 16:36:31 +10:00

newbs_building_firmware.md

Fix typo (#18526 )

2022-09-29 11:50:32 +01:00

newbs_flashing.md

Add note about qmk doctor in newbs_flashing.md (#15688 )

2022-07-02 22:48:44 +10:00

newbs_getting_started.md

Attempt to discourage manual MSYS install for new users (#17556 )

2022-07-04 00:41:00 +01:00

newbs_git_best_practices.md

…

newbs_git_resolving_merge_conflicts.md

…

newbs_git_resynchronize_a_branch.md

[Docs] Clean up some code block languages (#14434 )

2021-09-14 13:16:24 +01:00

newbs_git_using_your_master_branch.md

Add explicit id tags to externally linked headers

2020-03-05 16:00:10 -08:00

newbs_learn_more_resources.md

[Docs] Refactor code examples (#18003 )

2022-08-12 17:27:24 -07:00

newbs_testing_debugging.md

Small tweaks to docs to make them more user friendly (#11518 )

2021-01-20 18:46:01 +00:00

newbs.md

[Docs] Use HTTPS for images and links where possible (#11695 )

2021-01-30 22:00:56 +11:00

one_shot_keys.md

fix: Fix typo in documentation for one shot keys. ON_TOGG -> OS_TOGG (#13754 )

2021-07-28 12:00:55 +01:00

other_eclipse.md

[Docs] Address some typos (also in moonlander matrix.c) (#16248 )

2022-02-06 17:36:44 +00:00

other_vscode.md

Update other_vscode.md (#17317 )

2022-06-08 02:47:57 +01:00

platformdev_blackpill_f411.md

[Docs] Add information about WeAct Blackpill F411 (#16755 )

2022-07-27 14:49:12 +01:00

platformdev_chibios_earlyinit.md

[Docs] RESET -> QK_BOOT (#18365 )

2022-09-15 01:03:55 +01:00

platformdev_proton_c.md

Add converter docs (#17593 )

2022-07-08 22:49:16 +01:00

platformdev_rp2040.md

Merge remote-tracking branch 'origin/master' into develop

2022-10-05 01:38:10 +00:00

platformdev_selecting_arm_mcu.md

Add documentation for selecting an Arm MCU (#9046 )

2020-06-10 23:32:58 +01:00

porting_your_keyboard_to_qmk.md

Align new-keyboard with recent schema updates (#16378 )

2022-02-16 20:58:40 +00:00

power.txt

…

pr_checklist.md

Grammar Fix for PR Checklist (#18540 )

2022-09-30 05:28:12 +01:00

qmk_custom_dark.css

Small tweaks to docs to make them more user friendly (#11518 )

2021-01-20 18:46:01 +00:00

qmk_custom_light.css

Small tweaks to docs to make them more user friendly (#11518 )

2021-01-20 18:46:01 +00:00

qmk.css

…

quantum_keycodes.md

Add ability to enter bootloader mode from QK_MAKE (#17745 )

2022-07-23 17:43:32 +01:00

quantum_painter_qff.md

Quantum Painter (#10174 )

2022-04-13 18:00:18 +10:00

quantum_painter_qgf.md

Quantum Painter (#10174 )

2022-04-13 18:00:18 +10:00

quantum_painter_rle.md

Quantum Painter (#10174 )

2022-04-13 18:00:18 +10:00

quantum_painter.md

[QP] Add RGB565 surface. Docs clarification, cleanup, tabsification, and reordering. (#18396 )

2022-09-19 07:30:08 +10:00

README.md

Small tweaks to docs to make them more user friendly (#11518 )

2021-01-20 18:46:01 +00:00

redirects.json

…

ref_functions.md

Update ref_functions.md (replaced deprecated RESET) (#17436 )

2022-06-23 02:26:08 +01:00

reference_configurator_support.md

Basic keycode overhaul (#14726 )

2021-11-03 22:22:17 -07:00

reference_glossary.md

Fix Space Cadet md link (#14300 )

2021-09-04 15:01:56 +01:00

reference_info_json.md

[docs] Improve documentation regarding info.json (#18508 )

2022-09-29 13:08:45 -04:00

reference_keymap_extras.md

Rename keymap_extras headers for consistency (#16939 )

2022-05-15 21:27:01 +10:00

serial_driver.md

[Core] Add Raspberry Pi RP2040 support (#14877 )

2022-06-30 13:19:27 +02:00

spi_driver.md

Merge remote-tracking branch 'upstream/master' into develop

2021-02-08 07:57:09 +11:00

squeezing_avr.md

Add Elite-Pi converter (#18236 )

2022-09-08 14:59:27 -04:00

support.md

Fix capitalisation of "GitHub" (#9184 )

2020-05-25 19:43:14 -07:00

sw.js

…

syllabus.md

[Docs] Squeezing space out of AVR (#15243 )

2021-11-23 08:14:00 +11:00

tap_hold.md

docs: fix typos (#18671 )

2022-10-13 20:02:15 +01:00

translating.md

…

uart_driver.md

Update UART driver API (#14839 )

2021-11-13 18:23:14 +00:00

understanding_qmk.md

[Docs] Update 'Process Record' according to the code (#18209 )

2022-09-03 13:46:42 -04:00

unit_testing.md

Remove SERIAL_LINK feature (#14727 )

2021-10-07 12:32:05 +11:00

usb_nkro.txt

…

ws2812_driver.md

[Core] Add Raspberry Pi RP2040 support (#14877 )

2022-06-30 13:19:27 +02:00

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.

Help people out on our forums and chat rooms:
- /r/olkb
- Discord Server
Contribute to our documentation by clicking "Edit This Page" at the bottom
Translate our documentation into your language
Report a bug
Open a Pull Request