History

Ryan 3ecb0a80af Feature-ify Send String (#17275 )		2022-07-02 22:10:08 +10:00
..
ChangeLog	Breaking changes for 2022q2. (#17221 )	2022-05-29 07:50:21 +10:00
gitbook/images	…
internals	…
ja	Added Wait time to sending each Keys for Dynamic Macros function (#16800 )	2022-07-02 21:48:26 +10:00
zh-cn	Make default layer size 16-bit (#15286 )	2022-06-19 07:37:51 +10:00
.nojekyll	…
CNAME	…
README.md	…
_langs.md	…
_summary.md	Feature-ify Send String (#17275 )	2022-07-02 22:10:08 +10:00
adc_driver.md	…
api_development_environment.md	…
api_development_overview.md	…
api_docs.md	…
api_overview.md	…
arm_debugging.md	…
audio_driver.md	…
breaking_changes.md	Fixup command sequencing for master/develop. (#17227 )	2022-05-29 09:07:11 +10:00
breaking_changes_history.md	stub changelog	2022-05-24 01:55:34 +01:00
breaking_changes_instructions.md	…
chibios_upgrade_instructions.md	…
cli.md	…
cli_commands.md	Add cli command to import keyboard\|keymap\|kbfirmware (#16668 )	2022-07-02 21:50:09 +10:00
cli_configuration.md	…
cli_development.md	…
cli_tab_complete.md	Add Zsh note for tab complete (#17226 )	2022-07-02 21:59:59 +10:00
coding_conventions_c.md	…
coding_conventions_python.md	…
compatible_microcontrollers.md	[Core] Add Raspberry Pi RP2040 support (#14877 )	2022-06-30 13:19:27 +02:00
config_options.md	Do not enable PERMISSIVE_HOLD when TAPPING_TERM exceeds 500ms (#15674 )	2022-06-24 12:40:09 +02: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	…
data_driven_config.md	…
documentation_best_practices.md	…
documentation_templates.md	…
driver_installation_zadig.md	…
easy_maker.md	…
eeprom_driver.md	RP2040 emulated EEPROM. (#17519 )	2022-07-02 15:18:50 +10:00
faq_build.md	…
faq_debug.md	…
faq_general.md	…
faq_keymap.md	Keymap FAQ updates (#17130 )	2022-05-18 04:48:59 +10:00
faq_misc.md	…
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	…
feature_auto_shift.md	…
feature_backlight.md	…
feature_bluetooth.md	…
feature_bootmagic.md	…
feature_caps_word.md	…
feature_combo.md	…
feature_command.md	…
feature_debounce_type.md	…
feature_digitizer.md	…
feature_dip_switch.md	…
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_encoders.md	Breaking changes for 2022q2. (#17221 )	2022-05-29 07:50:21 +10:00
feature_grave_esc.md	…
feature_haptic_feedback.md	…
feature_hd44780.md	…
feature_joystick.md	…
feature_key_lock.md	…
feature_key_overrides.md	…
feature_layers.md	…
feature_layouts.md	…
feature_leader_key.md	…
feature_led_indicators.md	…
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	Feature-ify Send String (#17275 )	2022-07-02 22:10:08 +10: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	…
feature_pointing_device.md	improvements for Cirque Pinnacle trackpads (#17091 )	2022-06-25 22:22:28 +02:00
feature_programmable_button.md	…
feature_ps2_mouse.md	…
feature_rawhid.md	…
feature_rgb_matrix.md	Added global current to all other issi drivers who don't have it (#17448 )	2022-06-23 02:16:39 +01:00
feature_rgblight.md	…
feature_send_string.md	Feature-ify Send String (#17275 )	2022-07-02 22:10:08 +10:00
feature_sequencer.md	…
feature_space_cadet.md	…
feature_split_keyboard.md	Update feature_split_keyboard.md to add extra detail about left and right matrices. (#17492 )	2022-06-29 18:39:37 +10:00
feature_st7565.md	…
feature_stenography.md	Refactor steno and add `STENO_PROTOCOL = [all\|txbolt\|geminipr]` (#17065 )	2022-06-23 20:43:24 +02:00
feature_swap_hands.md	…
feature_tap_dance.md	tap-dance: Restructure code and document in more detail (#16394 )	2022-06-13 22:12:55 +02:00
feature_thermal_printer.md	…
feature_unicode.md	…
feature_userspace.md	…
feature_velocikey.md	…
feature_wpm.md	…
flash_driver.md	…
flashing.md	[Core] Add Raspberry Pi RP2040 support (#14877 )	2022-06-30 13:19:27 +02:00
flashing_bootloadhid.md	…
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	…
hand_wire.md	…
hardware_drivers.md	…
hardware_keyboard_guidelines.md	…
how_a_matrix_works.md	…
how_keyboards_work.md	docs: reflect systemd's change in language (#17322 )	2022-06-06 23:29:59 +01:00
i2c_driver.md	…
index.html	…
isp_flashing_guide.md	…
keycodes.md	PoC: Swap Escape and Caps (#16336 )	2022-07-02 22:08:48 +10:00
keycodes_basic.md	…
keycodes_magic.md	PoC: Swap Escape and Caps (#16336 )	2022-07-02 22:08:48 +10:00
keycodes_us_ansi_shifted.md	…
keymap.md	…
mod_tap.md	…
newbs.md	…
newbs_building_firmware.md	…
newbs_building_firmware_configurator.md	…
newbs_flashing.md	…
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	…
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	Update other_vscode.md (#17317 )	2022-06-08 02:47:57 +01:00
platformdev_chibios_earlyinit.md	Make bootloader_jump for dualbank STM32 respect STM32_BOOTLOADER_DUAL_BANK_DELAY (#17178 )	2022-05-30 23:20:10 -07:00
platformdev_rp2040.md	RP2040 emulated EEPROM. (#17519 )	2022-07-02 15:18:50 +10:00
platformdev_selecting_arm_mcu.md	…
porting_your_keyboard_to_qmk.md	…
power.txt	…
pr_checklist.md	Update pr_checklist.md (#17122 )	2022-05-17 14:20:13 +01:00
proton_c_conversion.md	…
qmk.css	…
qmk_custom_dark.css	…
qmk_custom_light.css	…
quantum_keycodes.md	…
quantum_painter.md	[QP] Add ILI9488 support. (#17438 )	2022-07-02 13:20:45 +10:00
quantum_painter_qff.md	…
quantum_painter_qgf.md	…
quantum_painter_rle.md	…
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	…
reference_glossary.md	…
reference_info_json.md	Merge remote-tracking branch 'origin/master' into develop	2022-07-02 11:27:40 +00: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	…
squeezing_avr.md	…
support.md	…
sw.js	…
syllabus.md	…
tap_hold.md	…
translating.md	…
uart_driver.md	…
understanding_qmk.md	Removes terminal from QMK. (#17258 )	2022-05-30 22:38:08 -07:00
unit_testing.md	…
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