tudattr/qmk_firmware
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
qmk_firmware/docs
History
Travis Rigg b85c224b7c
docs: reflect systemd's change in language (#17322) 
Like much of our field, systemd has renamed their `master` branch to `main`
2022-06-06 23:29:59 +01:00
..
ChangeLog
Breaking changes for 2022q2. (#17221)
2022-05-29 07:50:21 +10:00
gitbook/images
…
internals
Move Doxygen docs to subdirectory (#16561)
2022-03-07 11:22:22 +00:00
ja
Merge remote-tracking branch 'origin/master' into develop
2022-03-08 04:17:05 +00:00
zh-cn
Fix docs typo (#17254)
2022-05-30 23:05:57 +01:00
_langs.md
Remove stale docs translations (#15737)
2022-01-04 18:11:24 -08:00
_summary.md
stub changelog
2022-05-24 01:55:34 +01:00
.nojekyll
…
adc_driver.md
2021 May 29 Breaking Changes Update (#13034)
2021-05-29 14:38:50 -07:00
api_development_environment.md
…
api_development_overview.md
…
api_docs.md
[Docs] Address some typos (also in moonlander matrix.c) (#16248)
2022-02-06 17:36:44 +00: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] Clean up some code block languages (#14434)
2021-09-14 13:16:24 +01:00
breaking_changes_history.md
stub changelog
2022-05-24 01:55:34 +01:00
breaking_changes_instructions.md
…
breaking_changes.md
Fixup command sequencing for master/develop. (#17227)
2022-05-29 09:07:11 +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
Quantum Painter (#10174)
2022-04-13 18:00:18 +10:00
cli_configuration.md
…
cli_development.md
Some docs improvements (#15845)
2022-03-05 15:58:50 +11:00
cli_tab_complete.md
Fix Typo in documentation (#14942)
2021-10-24 23:32:42 +01:00
cli.md
…
CNAME
…
coding_conventions_c.md
[Docs] Use HTTPS for images and links where possible (#11695)
2021-01-30 22:00:56 +11:00
coding_conventions_python.md
Refactor new-keyboard to be python3.7 compatible (#14707)
2021-11-05 08:14:43 +11:00
compatible_microcontrollers.md
Added support for Wb32fq95 (#16871)
2022-05-23 15:57:24 +10:00
config_options.md
[Core] Add compile/make macro to core (#15959)
2022-03-17 21:19:34 +00:00
configurator_architecture.md
Architecture documentation for Configurator and API (#13935)
2021-08-10 07:47:53 -07:00
configurator_default_keymaps.md
Basic keycode overhaul (#14726)
2021-11-03 22:22:17 -07: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
…
contributing.md
update the Chinese translation based on the latest English version (#14924)
2022-01-18 18:24:02 +00:00
custom_matrix.md
[Docs] Clean up some code block languages (#14434)
2021-09-14 13:16:24 +01:00
custom_quantum_functions.md
Point out that deferred execution needs to be enabled in rules.mk (#16196)
2022-02-04 03:44:51 +00:00
data_driven_config.md
Change data driven "str" type to represent a quoted string literal (#16516)
2022-03-04 13:25:24 +00:00
documentation_best_practices.md
…
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
[Core] Add support for RISC-V builds and GD32VF103 MCU (#12508)
2021-10-18 16:23:20 +11: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
eeprom_i2c driver: added EXTERNAL_EEPROM_WP_PIN configuration option. (#12617)
2021-06-21 19:34:28 -07: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
doc/faq_debug: qmk cli can also be used to print debug messages (#15528)
2021-12-22 06:27:25 -08: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
Remove BOOTMAGIC_ENABLE = lite option (#15002)
2021-11-05 08:18:09 +11:00
feature_advanced_keycodes.md
Add trailing parens to get_oneshot_mods in feature_advanced_keycodes.md (#17211)
2022-05-31 21:31:47 +10:00
feature_audio.md
Fixup Audio startup and add to documents (#13606)
2021-08-15 21:51:50 +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_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
[Core] Add Caps Word feature to core (#16588)
2022-05-14 16:00:32 +10:00
feature_combo.md
New combo configuration options (#15083)
2022-01-09 12:02:25 -08:00
feature_command.md
Remove Full Bootmagic (#13846)
2021-08-06 23:59:56 -07: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
…
feature_encoders.md
Breaking changes for 2022q2. (#17221)
2022-05-29 07:50:21 +10: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
Joystick feature updates (#16732)
2022-03-26 18:38:09 +00: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
Move tmk_core/common/<plat> (#13918)
2021-11-19 10:41:02 -08: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
Refine LED indicator documentation (#16304)
2022-04-16 17:36:07 -07:00
feature_led_matrix.md
[Docs] Align LED Matrix docs with RGB matrix docs (#17140)
2022-05-20 09:13:40 -07:00
feature_macros.md
[Docs] feature_macro.md: minor formatting fix (#16205)
2022-02-05 08:15:21 +11:00
feature_midi.md
Move Doxygen docs to subdirectory (#16561)
2022-03-07 11:22:22 +00:00
feature_mouse_keys.md
Merge remote-tracking branch 'origin/master' into develop
2022-02-05 11:45:18 +00:00
feature_oled_driver.md
[Docs] OLED documentation edits (#15977)
2022-01-27 15:56:20 +00:00
feature_pointing_device.md
Add support for multiple sensors to pmw3360 (#15996)
2022-04-19 20:29:17 +10:00
feature_programmable_button.md
Add Support for USB programmable buttons (#12950)
2021-09-15 08:40:22 -07:00
feature_ps2_mouse.md
Align PS/2 GPIO defines (#14745)
2021-10-20 20:07:40 +01:00
feature_rawhid.md
[Docs] Clean up some code block languages (#14434)
2021-09-14 13:16:24 +01:00
feature_rgb_matrix.md
Merge remote-tracking branch 'origin/master' into develop
2022-05-20 17:10:54 +00:00
feature_rgblight.md
rgblight: Add functions to stop blinking one or all but one layer (#16859)
2022-04-17 00:02:32 +02: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
Merge remote-tracking branch 'origin/master' into develop
2022-01-12 22:06:23 +00:00
feature_st7565.md
ST7565 invert (#13237)
2021-06-19 18:51:35 +10:00
feature_stenography.md
[Docs] Update Steno Keycode Table (#17155)
2022-05-20 09:09:00 -07:00
feature_swap_hands.md
Add support for encoder mapping. (#13286)
2022-03-09 19:29:00 +11:00
feature_tap_dance.md
[Docs] Address some typos (also in moonlander matrix.c) (#16248)
2022-02-06 17:36:44 +00:00
feature_terminal.md
…
feature_thermal_printer.md
…
feature_unicode.md
Remove send_unicode_hex_string() (#16518)
2022-03-04 11:04:45 +00: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] Clean up some code block languages (#14434)
2021-09-14 13:16:24 +01:00
flashing.md
Fix docs typo (#17254)
2022-05-30 23:05:57 +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
[Docs] Added information on soldering diodes in parallel (#13117)
2021-07-29 22:56:27 -07: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
Basic keycode overhaul (#14726)
2021-11-03 22:22:17 -07:00
keycodes_magic.md
Implement MAGIC_TOGGLE_CONTROL_CAPSLOCK (#15368)
2021-11-30 17:34:08 -08: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
[Core] Add Caps Word feature to core (#16588)
2022-05-14 16:00:32 +10:00
keymap.md
Some docs improvements (#15845)
2022-03-05 15:58:50 +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.md
[Docs] Update newbs_building_firmware.md (#16333)
2022-02-21 09:08:07 -08:00
newbs_flashing.md
[Docs] newbs_flashing.md: add link to build environment section (#15654)
2022-01-10 16:54:22 -08:00
newbs_getting_started.md
Recommend pillow as part of manual MSYS install (#17133)
2022-05-17 21:50:48 +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
…
newbs_learn_more_resources.md
Add Atom editor suggestion (#15969)
2022-01-22 02:48:35 +11: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
[Docs] Address some typos (also in moonlander matrix.c) (#16248)
2022-02-06 17:36:44 +00:00
platformdev_chibios_earlyinit.md
Fixes for bootloader refactor build failures (#15638)
2022-01-06 06:55:46 +11:00
platformdev_selecting_arm_mcu.md
…
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
Update pr_checklist.md (#17122)
2022-05-17 14:20:13 +01:00
proton_c_conversion.md
Move Doxygen docs to subdirectory (#16561)
2022-03-07 11:22:22 +00: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
[Core] Add Reboot keycode to core (#15990)
2022-05-14 13:35:49 +10: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
Quantum Painter (#10174)
2022-04-13 18:00:18 +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
Fix typo in docs/ref_functions.md (#16690)
2022-03-19 16:37:35 +00: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
Fix in-page links in reference_info_json.md (#16487)
2022-03-07 18:50:03 -08:00
reference_keymap_extras.md
Rename keymap_extras headers for consistency (#16939)
2022-05-15 21:27:01 +10:00
serial_driver.md
Make solo half of split keyboards (more) usable. (#13523)
2021-08-22 10:51:17 +10:00
spi_driver.md
Merge remote-tracking branch 'upstream/master' into develop
2021-02-08 07:57:09 +11:00
squeezing_avr.md
[Core] Allow usage of AVRs minimal printf library (#16266)
2022-04-22 18:13:31 +10:00
support.md
…
sw.js
…
syllabus.md
[Docs] Squeezing space out of AVR (#15243)
2021-11-23 08:14:00 +11:00
tap_hold.md
Add GET_TAPPING_TERM macro to reduce duplicate code (#16681)
2022-04-16 11:24:09 -07:00
translating.md
…
uart_driver.md
Update UART driver API (#14839)
2021-11-13 18:23:14 +00:00
understanding_qmk.md
Some docs improvements (#15845)
2022-03-05 15:58:50 +11:00
unit_testing.md
Remove SERIAL_LINK feature (#14727)
2021-10-07 12:32:05 +11:00
usb_nkro.txt
…
ws2812_driver.md
Documentation typo fix (#15298)
2021-11-25 20:13:16 +00: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.