keychron_qmk_firmware/docs
2024-03-22 06:04:13 +00:00
..
ChangeLog 2024q1 develop changelog. (#23150) 2024-02-28 21:39:19 +11:00
gitbook/images
internals
ja Removal of bootmagic lite terminology (#22979) 2024-02-17 12:27:34 +00:00
zh-cn
_langs.md
_summary.md 2024q1 develop changelog. (#23150) 2024-02-28 21:39:19 +11:00
.nojekyll
adc_driver.md
apa102_driver.md
api_development_environment.md
api_development_overview.md
api_docs.md
api_overview.md
arm_debugging.md
audio_driver.md
breaking_changes_history.md 2024q1 develop changelog. (#23150) 2024-02-28 21:39:19 +11:00
breaking_changes_instructions.md
breaking_changes.md 2024q1 develop changelog. (#23150) 2024-02-28 21:39:19 +11:00
chibios_upgrade_instructions.md
cli_commands.md Initial 'qmk test-c' functionality (#23038) 2024-03-05 16:59:30 +00:00
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 Align SPLIT_HAND_MATRIX_GRID left/right logic with SPLIT_HAND_PIN (#22775) 2024-01-09 22:24:53 +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
custom_matrix.md
custom_quantum_functions.md Update naming convention for GPIO control macros (#23085) 2024-02-17 00:18:26 +11:00
data_driven_config.md
documentation_best_practices.md
documentation_templates.md
driver_installation_zadig.md Update Atmel DFU driver assignments for dfu-programmer 1.x (#23165) 2024-02-28 21:03:43 +11:00
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 [Audio] Add support for audio shutdown pin (#22731) 2024-03-06 22:02:37 +11:00
feature_auto_shift.md
feature_autocorrect.md
feature_backlight.md
feature_bluetooth.md
feature_bootmagic.md Removal of bootmagic lite terminology (#22979) 2024-02-17 12:27:34 +00:00
feature_caps_word.md
feature_combo.md Fix double code indenting (#23117) 2024-02-20 00:45:25 +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 [Doc] Use number indexes for encoder code example (#22980) 2024-01-29 19:28:23 +00:00
feature_grave_esc.md
feature_haptic_feedback.md
feature_hd44780.md
feature_joystick.md Fix joystick initialization (#22953) 2024-02-17 01:14:46 +11:00
feature_key_lock.md
feature_key_overrides.md
feature_layers.md
feature_layouts.md
feature_leader_key.md
feature_led_indicators.md Update naming convention for GPIO control macros (#23085) 2024-02-17 00:18:26 +11:00
feature_led_matrix.md LED drivers: update PWM register defines for g_<driver>_leds (#23052) 2024-02-12 02:19:45 +00:00
feature_macros.md
feature_midi.md
feature_mouse_keys.md
feature_oled_driver.md
feature_os_detection.md [Core] Add OS detection callbacks (#21777) 2024-02-17 01:19:02 +11:00
feature_pointing_device.md Add utility functions for Pointing Device Auto Mouse feature (#23144) 2024-03-10 05:34:41 +00:00
feature_programmable_button.md
feature_ps2_mouse.md
feature_rawhid.md add pywinusb lib to list of example libs for HID (#22747) 2024-01-09 22:13:51 +11:00
feature_repeat_key.md
feature_rgb_matrix.md LED drivers: update PWM register defines for g_<driver>_leds (#23052) 2024-02-12 02:19:45 +00:00
feature_rgblight.md Un-extern RGBLight led[] array (#23322) 2024-03-22 06:04:13 +00:00
feature_secure.md
feature_send_string.md
feature_sequencer.md
feature_space_cadet.md
feature_split_keyboard.md Align SPLIT_HAND_MATRIX_GRID left/right logic with SPLIT_HAND_PIN (#22775) 2024-01-09 22:24:53 +11:00
feature_st7565.md
feature_stenography.md
feature_swap_hands.md
feature_tap_dance.md
feature_tri_layer.md Update feature_tri_layer.md - typo (#23275) 2024-03-14 14:28:54 +11:00
feature_unicode.md
feature_userspace.md
feature_wpm.md
flash_driver.md
flashing_bootloadhid.md
flashing.md
fuse.txt
getting_started_docker.md
getting_started_github.md
getting_started_introduction.md Modify wording in 'getting_started_introduction.md' (#23232) 2024-03-14 19:00:03 -07:00
getting_started_make_guide.md
gpio_control.md Update naming convention for GPIO control macros (#23085) 2024-02-17 00:18:26 +11:00
hand_wire.md
hardware_drivers.md
hardware_keyboard_guidelines.md
how_a_matrix_works.md
how_keyboards_work.md
i2c_driver.md Update naming convention for GPIO control macros (#23085) 2024-02-17 00:18:26 +11:00
index.html
isp_flashing_guide.md
keycodes_basic.md
keycodes_magic.md
keycodes_us_ansi_shifted.md
keycodes.md
keymap.md
mod_tap.md
newbs_building_firmware_configurator.md
newbs_building_firmware_workflow.md
newbs_building_firmware.md
newbs_external_userspace.md
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
other_eclipse.md
other_vscode.md Add instructions for debugging ARM with VSCode+BMP. (#11217) 2024-03-08 22:24:11 +11:00
platformdev_blackpill_f4x1.md
platformdev_chibios_earlyinit.md
platformdev_proton_c.md
platformdev_rp2040.md [Core] Allow ChibiOS SIO driver for UART driver (#22839) 2024-02-20 11:34:24 +01:00
platformdev_selecting_arm_mcu.md
porting_your_keyboard_to_qmk.md
power.txt
pr_checklist.md Updates to PR Checklist (#23318) 2024-03-20 09:09:29 -06:00
qmk_custom_dark.css
qmk_custom_light.css
qmk.css
quantum_keycodes.md
quantum_painter_lvgl.md
quantum_painter_qff.md
quantum_painter_qgf.md
quantum_painter_rle.md
quantum_painter.md [Driver] ILI9486 on Quantum Painter (#18521) 2024-02-17 18:36:05 +11:00
README.md
redirects.json
ref_functions.md
reference_configurator_support.md
reference_glossary.md
reference_info_json.md LED drivers: add support for IS31FL3236 (#23264) 2024-03-17 19:23:14 +11:00
reference_keymap_extras.md
serial_driver.md
spi_driver.md
squeezing_avr.md
support_deprecation_policy.md
support.md
sw.js
syllabus.md
tap_hold.md
translating.md
uart_driver.md [Core] Allow ChibiOS SIO driver for UART driver (#22839) 2024-02-20 11:34:24 +01:00
understanding_qmk.md
unit_testing.md
usb_nkro.txt
ws2812_driver.md WS2812 PWM: prefix for DMA defines (#23111) 2024-03-02 17:16:47 +00:00

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.