History

Wes Lord 244f27ac27 Remove orphan custom functions reference in keymap docs (#18444 )		2022-09-24 09:04:14 -07:00
..
ChangeLog	2022q3 Changelog. (#18180 )	2022-08-28 14:20:52 +10:00
gitbook/images	…
internals	…
ja	[Docs] RESET -> QK_BOOT (#18365 )	2022-09-15 01:03:55 +01:00
zh-cn	[Docs] RESET -> QK_BOOT (#18365 )	2022-09-15 01:03:55 +01:00
.nojekyll	…
CNAME	…
README.md	…
_langs.md	…
_summary.md	[Docs] Extract 'Layer Change Code' and EEPROM (#18174 )	2022-09-19 02:20:22 +01:00
adc_driver.md	…
api_development_environment.md	…
api_development_overview.md	…
api_docs.md	[Docs] RESET -> QK_BOOT (#18365 )	2022-09-15 01:03:55 +01:00
api_overview.md	…
arm_debugging.md	…
audio_driver.md	[Docs] Fix tables in Audio driver document (#17780 )	2022-07-25 00:00:51 +01:00
breaking_changes.md	2022q3 Changelog. (#18180 )	2022-08-28 14:20:52 +10:00
breaking_changes_history.md	2022q3 Changelog. (#18180 )	2022-08-28 14:20:52 +10:00
breaking_changes_instructions.md	…
chibios_upgrade_instructions.md	…
cli.md	…
cli_commands.md	CLI: Teaching the CLI to flash binaries (#16584 )	2022-08-20 15:39:19 +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	Tentative Teensy 3.5 support (#14420 )	2022-07-03 00:12:45 +10:00
config_options.md	Remove `UNUSED_PINS` (#17931 )	2022-08-06 23:23:35 +10:00
configurator_architecture.md	…
configurator_default_keymaps.md	[Docs] RESET -> QK_BOOT (#18365 )	2022-09-15 01:03:55 +01:00
configurator_diagram.drawio	…
configurator_diagram.svg	…
configurator_step_by_step.md	…
configurator_troubleshooting.md	…
contributing.md	…
custom_matrix.md	Make debounce() signal changes in the cooked matrix as return value (#17554 )	2022-07-07 10:00:40 +02: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	[Docs] Fix typo in data driven config docs (#18095 )	2022-08-18 18:18:51 -07:00
documentation_best_practices.md	…
documentation_templates.md	…
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	…
faq_debug.md	[Docs] Fix custom debug function and sample output (#17790 )	2022-07-25 23:07:15 +01:00
faq_general.md	…
faq_keymap.md	…
faq_misc.md	[Docs] RESET -> QK_BOOT (#18365 )	2022-09-15 01:03:55 +01:00
feature_advanced_keycodes.md	[Docs] Extract 'Layer Change Code' and EEPROM (#18174 )	2022-09-19 02:20:22 +01:00
feature_audio.md	[Docs] RESET -> QK_BOOT (#18365 )	2022-09-15 01:03:55 +01:00
feature_auto_shift.md	…
feature_backlight.md	…
feature_bluetooth.md	…
feature_bootmagic.md	…
feature_caps_word.md	Expand on the differences between Caps Word and Caps Lock (#18139 )	2022-08-30 10:03:25 +02:00
feature_combo.md	[Docs] Use layer number as example for COMBO_ONLY_FROM_LAYER (#18072 )	2022-08-16 19:37:06 -07:00
feature_command.md	…
feature_converters.md	Add Bonsai C4 converter (#17711 )	2022-08-18 01:01:54 +01:00
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_eeprom.md	[Docs] Extract 'Layer Change Code' and EEPROM (#18174 )	2022-09-19 02:20:22 +01:00
feature_encoders.md	Discourage use of ENCODER_MAP at keyboard level (#18286 )	2022-09-06 18:08:48 +01: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	[Docs] Extract 'Layer Change Code' and EEPROM (#18174 )	2022-09-19 02:20:22 +01:00
feature_layouts.md	…
feature_leader_key.md	…
feature_led_indicators.md	…
feature_led_matrix.md	…
feature_macros.md	implement `tap_code16_delay` (#17748 )	2022-07-23 19:21:20 +01:00
feature_midi.md	…
feature_mouse_keys.md	…
feature_oled_driver.md	Remove OLED driver Split Common warning (#17862 )	2022-07-31 12:33:12 -07:00
feature_pointing_device.md	Create generic Pointing Device Pin defines (#17776 )	2022-08-12 16:22:34 -07:00
feature_programmable_button.md	…
feature_ps2_mouse.md	…
feature_rawhid.md	…
feature_rgb_matrix.md	Merge remote-tracking branch 'origin/master' into develop	2022-08-13 00:27:58 +00:00
feature_rgblight.md	Add deprecated check for RGBLIGHT_ANIMATIONS (#17832 )	2022-08-04 11:05:53 -07:00
feature_secure.md	Add basic secure docs (#17577 )	2022-07-13 00:06:19 +01:00
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	Rename postprocess_steno_user → post_process_steno_user (#17823 )	2022-07-28 21:51:01 -07:00
feature_swap_hands.md	…
feature_tap_dance.md	Merge remote-tracking branch 'origin/master' into develop	2022-08-22 23:06:18 +00:00
feature_thermal_printer.md	…
feature_unicode.md	Added emacs as an "operating system" for input mode. (#16949 )	2022-08-14 20:24:52 +01:00
feature_userspace.md	…
feature_velocikey.md	…
feature_wpm.md	…
flash_driver.md	…
flashing.md	[Docs] RESET -> QK_BOOT (#18365 )	2022-09-15 01:03:55 +01:00
flashing_bootloadhid.md	[Docs] RESET -> QK_BOOT (#18365 )	2022-09-15 01:03:55 +01: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	…
hand_wire.md	Improve importer workflow (#17707 )	2022-08-13 14:39:56 +01:00
hardware_drivers.md	…
hardware_keyboard_guidelines.md	…
how_a_matrix_works.md	…
how_keyboards_work.md	…
i2c_driver.md	…
index.html	…
isp_flashing_guide.md	…
keycodes.md	Add ability to enter bootloader mode from `QK_MAKE` (#17745 )	2022-07-23 17:43:32 +01: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	Remove orphan custom functions reference in keymap docs (#18444 )	2022-09-24 09:04:14 -07:00
mod_tap.md	…
newbs.md	…
newbs_building_firmware.md	…
newbs_building_firmware_configurator.md	…
newbs_building_firmware_workflow.md	[Docs] Building with GitHub Userspace (#16271 )	2022-08-06 16:36:31 +10:00
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	Attempt to discourage manual MSYS install for new users (#17556 )	2022-07-04 00:41:00 +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	[Docs] Refactor code examples (#18003 )	2022-08-12 17:27:24 -07:00
newbs_testing_debugging.md	…
one_shot_keys.md	…
other_eclipse.md	…
other_vscode.md	…
platformdev_blackpill_f411.md	[Docs] Add information about WeAct Blackpill F411 (#16755 )	2022-07-27 14:49:12 +01:00
platformdev_chibios_earlyinit.md	[Docs] RESET -> QK_BOOT (#18365 )	2022-09-15 01:03:55 +01:00
platformdev_proton_c.md	Add converter docs (#17593 )	2022-07-08 22:49:16 +01: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	[Docs] Explicitly mention kb/user callbacks as boolean (#18448 )	2022-09-21 14:00:25 -07:00
qmk.css	…
qmk_custom_dark.css	…
qmk_custom_light.css	…
quantum_keycodes.md	Add ability to enter bootloader mode from `QK_MAKE` (#17745 )	2022-07-23 17:43:32 +01:00
quantum_painter.md	Add ST7735 driver to Quantum Painter (#17848 )	2022-07-31 19:58:25 -07:00
quantum_painter_qff.md	…
quantum_painter_qgf.md	…
quantum_painter_rle.md	…
redirects.json	…
ref_functions.md	…
reference_configurator_support.md	…
reference_glossary.md	…
reference_info_json.md	Merge remote-tracking branch 'origin/master' into develop	2022-07-13 01:19:58 +01:00
reference_keymap_extras.md	…
serial_driver.md	[Core] Add Raspberry Pi RP2040 support (#14877 )	2022-06-30 13:19:27 +02:00
spi_driver.md	…
squeezing_avr.md	[Docs] Update list of "ARM-based ProMicro replacements" (#18083 )	2022-08-18 18:17:20 -07:00
support.md	…
sw.js	…
syllabus.md	…
tap_hold.md	…
translating.md	…
uart_driver.md	…
understanding_qmk.md	[Docs] Update 'Process Record' according to the code (#18209 )	2022-09-03 13:46:42 -04: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