keychron_qmk_firmware/docs
2023-01-24 15:18:09 +00:00
..
ChangeLog Merge remote-tracking branch 'origin/master' into develop 2023-01-19 11:31:19 +00:00
gitbook/images
internals
ja Merge remote-tracking branch 'origin/master' into develop 2022-12-14 14:44:19 +00:00
zh-cn KC_GESC -> QK_GESC for cn and ja Docs (#19024) 2022-12-09 03:03:33 +11:00
_langs.md
_summary.md [Core] Quantum Painter - LVGL Integration (#18499) 2022-12-13 07:51:14 +11:00
.nojekyll
adc_driver.md Add analog support for RP2040 (#19453) 2023-01-19 10:30:58 +11:00
api_development_environment.md
api_development_overview.md
api_docs.md 2022 Nov 26 changelog. (#19164) 2022-11-28 07:33:55 +11:00
api_overview.md
arm_debugging.md
audio_driver.md
breaking_changes_history.md Stub next develop dates 2022-11-22 01:27:15 +00:00
breaking_changes_instructions.md
breaking_changes.md Minor cleanup to breaking/checklist docs. (#19596) 2023-01-19 22:30:16 +11:00
chibios_upgrade_instructions.md Add qmk mass-compile, which intends to supercede qmk multibuild whilst providing support for filtering as per data-driven definitions. (#18971) 2023-01-04 04:10:18 +00:00
cli_commands.md
cli_configuration.md
cli_development.md
cli_tab_complete.md
cli.md
CNAME
coding_conventions_c.md
coding_conventions_python.md
compatible_microcontrollers.md
config_options.md Remove IGNORE_MOD_TAP_INTERRUPT_PER_KEY in favour of HOLD_ON_OTHER_KEY_PRESS_PER_KEY (#15741) 2022-12-13 22:20:07 +11:00
configurator_architecture.md
configurator_default_keymaps.md
configurator_diagram.drawio
configurator_diagram.svg
configurator_step_by_step.md
configurator_troubleshooting.md
contributing.md Minor cleanup to breaking/checklist docs. (#19596) 2023-01-19 22:30:16 +11:00
custom_matrix.md
custom_quantum_functions.md
data_driven_config.md
documentation_best_practices.md
documentation_templates.md [Docs] Touch up documentation templates & porting keyboard docs (#19573) 2023-01-13 02:58:38 -08:00
driver_installation_zadig.md
easy_maker.md
eeprom_driver.md
faq_build.md
faq_debug.md
faq_general.md
faq_keymap.md
faq_misc.md
feature_advanced_keycodes.md
feature_audio.md
feature_auto_shift.md Remove IGNORE_MOD_TAP_INTERRUPT_PER_KEY in favour of HOLD_ON_OTHER_KEY_PRESS_PER_KEY (#15741) 2022-12-13 22:20:07 +11:00
feature_autocorrect.md
feature_backlight.md
feature_bluetooth.md
feature_bootmagic.md
feature_caps_word.md
feature_combo.md A comma was missing (#19507) 2023-01-05 15:12:46 +00:00
feature_command.md
feature_converters.md
feature_debounce_type.md
feature_digitizer.md
feature_dip_switch.md
feature_dynamic_macros.md
feature_eeprom.md
feature_encoders.md docs: add a note about reflashing both halves for encoder resolution (#19162) 2022-12-30 11:50:37 +11:00
feature_grave_esc.md
feature_haptic_feedback.md
feature_hd44780.md
feature_joystick.md [Docs] Fix JOYSTICK_AXIS_COUNT name in docs (#19605) 2023-01-16 00:52:18 -08:00
feature_key_lock.md
feature_key_overrides.md
feature_layers.md Small doc changes (#19601) 2023-01-16 01:32:43 -08:00
feature_layouts.md
feature_leader_key.md Merge remote-tracking branch 'origin/master' into develop 2023-01-18 00:26:53 +00:00
feature_led_indicators.md Remove deprecated led_set_kb (#19273) 2022-12-14 11:14:10 +00:00
feature_led_matrix.md docs: Fix IS31FL3743A driver name (#19518) 2023-01-06 17:12:30 +00:00
feature_macros.md
feature_midi.md
feature_mouse_keys.md
feature_oled_driver.md Update OLED doc (#19213) 2022-11-30 17:48:23 +00:00
feature_os_detection.md Detect host OS based on USB fingerprint (#18463) 2022-12-09 03:45:30 +11:00
feature_pointing_device.md Add *_RIGHT configuration for PMW33XX driver (#19243) 2022-12-10 13:18:40 +11:00
feature_programmable_button.md
feature_ps2_mouse.md
feature_rawhid.md
feature_rgb_matrix.md Use consistent highlight format (#19619) 2023-01-18 01:22:34 +00:00
feature_rgblight.md Fix description for selectively disabling animations (#19374) 2022-12-19 19:10:11 +11:00
feature_secure.md
feature_send_string.md
feature_sequencer.md
feature_space_cadet.md
feature_split_keyboard.md Add Split support for Haptic feedback (#19203) 2023-01-01 11:56:32 +11:00
feature_st7565.md
feature_stenography.md
feature_swap_hands.md
feature_tap_dance.md Tap Dance: remove qk_ prefix (#19313) 2022-12-14 12:40:25 -08:00
feature_unicode.md Merge remote-tracking branch 'origin/master' into develop 2022-12-31 21:23:49 +00:00
feature_userspace.md
feature_velocikey.md
feature_wpm.md
flash_driver.md
flashing_bootloadhid.md
flashing.md Add f303 to tinyuf2 bootloader support (#19620) 2023-01-18 22:36:58 +00:00
fuse.txt
getting_started_docker.md
getting_started_github.md
getting_started_introduction.md
getting_started_make_guide.md
getting_started_vagrant.md
gpio_control.md Fix functions with empty params (#19647) 2023-01-20 16:21:17 +00:00
hand_wire.md
hardware_drivers.md
hardware_keyboard_guidelines.md Merge remote-tracking branch 'origin/master' into develop 2023-01-01 00:53:46 +00:00
how_a_matrix_works.md
how_keyboards_work.md
i2c_driver.md
index.html
isp_flashing_guide.md
keycodes_basic.md
keycodes_magic.md
keycodes_us_ansi_shifted.md
keycodes.md Fix RWIN typo within keycode list (#19155) 2022-11-28 05:25:56 +00:00
keymap.md Remove useless line continuations (#19399) 2022-12-30 11:48:05 +11:00
mod_tap.md
newbs_building_firmware_configurator.md
newbs_building_firmware_workflow.md
newbs_building_firmware.md Align new-keymap with new-keyboard (#19229) 2022-12-03 12:04:06 +00:00
newbs_flashing.md
newbs_getting_started.md
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
newbs.md
one_shot_keys.md fix typo (#19189) 2022-11-29 16:34:20 +00:00
other_eclipse.md
other_vscode.md
platformdev_blackpill_f4x1.md Docs: typo fixes in platformdev_blackpill_f4x1.md (#19635) 2023-01-19 16:09:11 -07:00
platformdev_chibios_earlyinit.md
platformdev_proton_c.md
platformdev_rp2040.md Add analog support for RP2040 (#19453) 2023-01-19 10:30:58 +11:00
platformdev_selecting_arm_mcu.md
porting_your_keyboard_to_qmk.md [Docs] Touch up documentation templates & porting keyboard docs (#19573) 2023-01-13 02:58:38 -08:00
power.txt
pr_checklist.md Minor cleanup to breaking/checklist docs. (#19596) 2023-01-19 22:30:16 +11:00
qmk_custom_dark.css
qmk_custom_light.css
qmk.css
quantum_keycodes.md
quantum_painter_lvgl.md Fix functions with empty params (#19647) 2023-01-20 16:21:17 +00:00
quantum_painter_qff.md
quantum_painter_qgf.md
quantum_painter_rle.md
quantum_painter.md Add RGB565 and RGB888 color support to Quantum Painter (#19382) 2023-01-14 21:24:54 +11:00
README.md
redirects.json
ref_functions.md
reference_configurator_support.md
reference_glossary.md
reference_info_json.md Rework input_pressed_state docs (#19267) 2022-12-08 20:41:38 +00:00
reference_keymap_extras.md
serial_driver.md
spi_driver.md
squeezing_avr.md
support.md
sw.js
syllabus.md
tap_hold.md Remove IGNORE_MOD_TAP_INTERRUPT_PER_KEY in favour of HOLD_ON_OTHER_KEY_PRESS_PER_KEY (#15741) 2022-12-13 22:20:07 +11:00
translating.md
uart_driver.md
understanding_qmk.md Update understanding_qmk.md (#19664) 2023-01-24 15:17:24 +00:00
unit_testing.md
usb_nkro.txt
ws2812_driver.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.