dev/qmk_firmware
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 2
qmk_firmware/docs
History
lokher e4f4ceaf3f merge upstream 713427c
2023-04-26 16:32:15 +08:00
..
ChangeLog merge upstream 713427c 2023-04-26 16:32:15 +08:00
gitbook/images
internals Move Doxygen docs to subdirectory (#16561) 2022-03-07 11:22:22 +00:00
ja
zh-cn
.nojekyll
_langs.md Remove stale docs translations (#15737) 2022-01-04 18:11:24 -08:00
_summary.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
adc_driver.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
api_development_environment.md Add API documentation 2020-03-05 16:00:10 -08:00
api_development_overview.md
api_docs.md 2022 Nov 26 changelog. (#19164) 2022-11-28 07:33:55 +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 [Core] Adjust PWM hardware audio driver for RP2040 (#17723) 2022-10-27 19:26:16 +02:00
breaking_changes.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
breaking_changes_history.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
breaking_changes_instructions.md 2020 May 30 Breaking Changes Update (#9215) 2020-05-30 13:14:59 -07:00
chibios_upgrade_instructions.md
cli.md
cli_commands.md
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
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
configurator_architecture.md
configurator_default_keymaps.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
configurator_diagram.drawio
configurator_diagram.svg
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 merge upstream 713427c 2023-04-26 16:32:15 +08:00
custom_matrix.md merge upstream 713427c 2023-04-26 16:32:15 +08: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
documentation_best_practices.md [Docs] fix file path (#9540) 2020-06-25 15:58:36 +10:00
documentation_templates.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
driver_installation_zadig.md [Docs] RESET -> QK_BOOT (#18365) 2022-09-15 01:03:55 +01:00
easy_maker.md
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 Remove legacy Debug keycode (#18769) 2022-10-19 11:33:05 +01: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
feature_audio.md Align audio keycode names (#18962) 2022-11-05 17:05:19 +00:00
feature_auto_shift.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
feature_autocorrect.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
feature_backlight.md
feature_bluetooth.md Normalise output selection (Bluetooth) keycodes (#19004) 2022-11-08 19:03:31 +00:00
feature_bootmagic.md
feature_caps_word.md
feature_combo.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
feature_command.md
feature_converters.md
feature_debounce_type.md
feature_digitizer.md Digitizer feature improvements (#19034) 2022-11-12 23:28:11 +00:00
feature_dip_switch.md
feature_dynamic_macros.md Normalise Dynamic Macro keycodes (#18939) 2022-11-03 23:01:06 +00:00
feature_eeprom.md Remove rgblight_list.h (#18878) 2022-10-27 23:50:14 +01:00
feature_encoders.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
feature_grave_esc.md Rename some Quantum keycodes (#15968) 2022-01-22 03:34:15 +00:00
feature_haptic_feedback.md
feature_hd44780.md
feature_joystick.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
feature_key_lock.md
feature_key_overrides.md
feature_layers.md
feature_layouts.md [Docs] Clean up some code block languages (#14434) 2021-09-14 13:16:24 +01:00
feature_leader_key.md
feature_led_indicators.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
feature_led_matrix.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
feature_macros.md Macro keycode name refactoring (#18958) 2022-11-05 23:22:11 +11:00
feature_midi.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
feature_mouse_keys.md add "inertia" mode for mouse keys (#18774) 2022-10-26 20:49:44 +01:00
feature_oled_driver.md
feature_os_detection.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
feature_pointing_device.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
feature_programmable_button.md
feature_ps2_mouse.md [Core] Rework PS/2 driver selection (#17892) 2022-08-31 09:16:07 +02:00
feature_rawhid.md
feature_rgb_matrix.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
feature_rgblight.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
feature_secure.md Deprecate SECURE_* keycodes for QK_SECURE_* (#18847) 2022-10-25 22:59:17 +01:00
feature_send_string.md Feature-ify Send String (#17275) 2022-07-02 22:10:08 +10:00
feature_sequencer.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
feature_space_cadet.md
feature_split_keyboard.md
feature_st7565.md
feature_stenography.md Rename postprocess_steno_user → post_process_steno_user (#17823) 2022-07-28 21:51:01 -07:00
feature_swap_hands.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
feature_tap_dance.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
feature_tri_layer.md
feature_unicode.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
feature_userspace.md Enable CLI flashing via mdloader (#14729) 2021-10-15 22:07:33 +01:00
feature_velocikey.md
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
flashing.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
flashing_bootloadhid.md
fuse.txt Ensure single newline at EOF for core files (#11310) 2020-12-28 04:36:32 +11:00
getting_started_docker.md
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 merge upstream 713427c 2023-04-26 16:32:15 +08: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 merge upstream 713427c 2023-04-26 16:32:15 +08: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.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
keycodes_basic.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
keycodes_magic.md merge upstream 713427c 2023-04-26 16:32:15 +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
keymap.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
mod_tap.md [Docs] Address some typos (also in moonlander matrix.c) (#16248) 2022-02-06 17:36:44 +00:00
newbs.md [Docs] Use HTTPS for images and links where possible (#11695) 2021-01-30 22:00:56 +11:00
newbs_building_firmware.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
newbs_building_firmware_configurator.md
newbs_building_firmware_workflow.md
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 merge upstream 713427c 2023-04-26 16:32:15 +08:00
newbs_git_best_practices.md
newbs_git_resolving_merge_conflicts.md
newbs_git_resynchronize_a_branch.md
newbs_git_using_your_master_branch.md
newbs_learn_more_resources.md
newbs_testing_debugging.md
one_shot_keys.md
other_eclipse.md
other_vscode.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
platformdev_blackpill_f4x1.md
platformdev_chibios_earlyinit.md
platformdev_proton_c.md Add converter docs (#17593) 2022-07-08 22:49:16 +01:00
platformdev_rp2040.md
platformdev_selecting_arm_mcu.md
porting_your_keyboard_to_qmk.md
power.txt Trim trailing whitespace 2017-12-09 10:46:11 -05:00
pr_checklist.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
qmk.css Some more tweaks to make everything look nice 2018-05-07 23:42:41 -07: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
quantum_keycodes.md Add ability to enter bootloader mode from QK_MAKE (#17745) 2022-07-23 17:43:32 +01:00
quantum_painter.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
quantum_painter_lvgl.md merge upstream 713427c 2023-04-26 16:32:15 +08: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
README.md Small tweaks to docs to make them more user friendly (#11518) 2021-01-20 18:46:01 +00:00
redirects.json Configuration system for CLI (#6708) 2019-09-22 13:25:33 -07:00
ref_functions.md Remove legacy EEPROM clear keycodes (#18782) 2022-10-20 12:20:07 +01:00
reference_configurator_support.md
reference_glossary.md
reference_info_json.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
reference_keymap_extras.md Rename keymap_extras headers for consistency (#16939) 2022-05-15 21:27:01 +10:00
serial_driver.md
spi_driver.md Merge remote-tracking branch 'upstream/master' into develop 2021-02-08 07:57:09 +11:00
squeezing_avr.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
support.md
support_deprecation_policy.md
sw.js Fix up info boxes. 2018-05-07 22:46:26 -07:00
syllabus.md [Docs] Squeezing space out of AVR (#15243) 2021-11-23 08:14:00 +11:00
tap_hold.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
translating.md Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) 2019-11-28 22:14:04 +00:00
uart_driver.md Update UART driver API (#14839) 2021-11-13 18:23:14 +00:00
understanding_qmk.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
unit_testing.md
usb_nkro.txt
ws2812_driver.md [Core] Allow custom timings for WS2812 PIO driver (#18006) 2022-11-10 07:58:15 +11: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.