History

jacob-w-gable 99290b4c7e Add full solenoid support on split keyboards (#21583 ) Co-authored-by: Jacob Gable <jacob.gable@statheros.tech>		2023-09-25 12:23:31 +10:00
..
ChangeLog	Breaking changes changelog, 2023q3 version (#21848 )	2023-08-29 21:15:21 +10:00
gitbook/images	…
internals	…
ja	Consolidate `KEYBOARD_OUTPUT`+`KEYMAP_OUTPUT`=>`INTERMEDIATE_OUTPUT` (#21272 )	2023-06-21 08:41:49 +10:00
zh-cn	…
.nojekyll	…
CNAME	Create CNAME	2018-05-21 16:29:37 -04:00
README.md	…
_langs.md	…
_summary.md	Move Digitizer to "Software Features" (#22031 )	2023-09-17 08:11:32 +01:00
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	…
api_overview.md	…
arm_debugging.md	…
audio_driver.md	…
breaking_changes.md	Breaking changes changelog, 2023q3 version (#21848 )	2023-08-29 21:15:21 +10:00
breaking_changes_history.md	Breaking changes changelog, 2023q3 version (#21848 )	2023-08-29 21:15:21 +10:00
breaking_changes_instructions.md	…
chibios_upgrade_instructions.md	…
cli.md	…
cli_commands.md	…
cli_configuration.md	…
cli_development.md	docs: some typos (#18582 )	2022-10-05 17:32:07 +01:00
cli_tab_complete.md	…
coding_conventions_c.md	…
coding_conventions_python.md	…
compatible_microcontrollers.md	…
config_options.md	Bluetooth: driver naming cleanups (#21624 )	2023-07-29 15:16:14 +10:00
configurator_architecture.md	…
configurator_default_keymaps.md	…
configurator_diagram.drawio	…
configurator_diagram.svg	…
configurator_step_by_step.md	…
configurator_troubleshooting.md	…
contributing.md	Breaking changes changelog, 2023q3 version (#21848 )	2023-08-29 21:15:21 +10:00
custom_matrix.md	…
custom_quantum_functions.md	[Doc] Add example to keyboard housekeeping and some minor fixes (#19968 )	2023-03-15 16:55:18 -06:00
data_driven_config.md	…
documentation_best_practices.md	…
documentation_templates.md	…
driver_installation_zadig.md	…
easy_maker.md	…
eeprom_driver.md	Default wear leveling logical size to half backing (#22006 )	2023-09-14 07:13:21 +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	…
faq_general.md	…
faq_keymap.md	…
faq_misc.md	…
feature_advanced_keycodes.md	…
feature_audio.md	…
feature_auto_shift.md	…
feature_autocorrect.md	…
feature_backlight.md	[Core] Allow customizing PWM frequency (#21717 )	2023-09-03 14:56:02 +02:00
feature_bluetooth.md	Bluetooth: driver naming cleanups (#21624 )	2023-07-29 15:16:14 +10:00
feature_bootmagic.md	…
feature_caps_word.md	[Core] Caps Word "Invert on shift" option: pressing Shift inverts the shift state. (#20092 )	2023-04-04 09:11:26 +10:00
feature_combo.md	…
feature_command.md	…
feature_converters.md	…
feature_debounce_type.md	Add debounce time description (#20333 )	2023-04-04 12:15:00 +10:00
feature_digitizer.md	…
feature_dip_switch.md	…
feature_dynamic_macros.md	…
feature_eeprom.md	…
feature_encoders.md	…
feature_grave_esc.md	…
feature_haptic_feedback.md	haptic: further naming cleanups (#21682 )	2023-08-04 01:16:16 +01:00
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	Changed interverts to inverts (#21270 )	2023-07-03 17:01:10 +01:00
feature_layouts.md	…
feature_leader_key.md	…
feature_led_indicators.md	…
feature_led_matrix.md	Add and use I2C address defines for ISSI LED drivers (#22008 )	2023-09-19 19:31:54 +10:00
feature_macros.md	Corrected duration example, should be number not string (#21839 )	2023-08-26 19:43:40 +01:00
feature_midi.md	…
feature_mouse_keys.md	…
feature_oled_driver.md	Merge remote-tracking branch 'origin/master' into develop	2023-09-23 02:19:10 +00:00
feature_os_detection.md	…
feature_pointing_device.md	…
feature_programmable_button.md	Normalise Joystick and Programmable Button keycodes (#18832 )	2022-10-24 15:50:33 +01:00
feature_ps2_mouse.md	…
feature_rawhid.md	Raw HID: documentation improvements (#21596 )	2023-07-25 09:20:41 +10:00
feature_repeat_key.md	…
feature_rgb_matrix.md	Update AW20216S LED type (#22072 )	2023-09-20 11:50:52 +01:00
feature_rgblight.md	Merge remote-tracking branch 'origin/master' into develop	2023-09-25 01:51:10 +00:00
feature_secure.md	…
feature_send_string.md	…
feature_sequencer.md	…
feature_space_cadet.md	…
feature_split_keyboard.md	Add full solenoid support on split keyboards (#21583 )	2023-09-25 12:23:31 +10:00
feature_st7565.md	…
feature_stenography.md	…
feature_swap_hands.md	Add swap hands toggle functions (#20381 )	2023-04-09 09:37:31 -07:00
feature_tap_dance.md	On-each-release tap dance function (#20255 )	2023-07-26 21:04:35 -07:00
feature_tri_layer.md	[Core] Tri Layer Keys (#19795 )	2023-02-12 10:23:07 +11:00
feature_unicode.md	Unicode, Unicodemap and UCIS refactor (#21659 )	2023-08-27 13:30:19 +10:00
feature_userspace.md	…
feature_velocikey.md	Deprecate `VLK_TOG` for `VK_TOGG` (#18807 )	2022-10-22 21:45:20 +01:00
feature_wpm.md	…
flash_driver.md	…
flashing.md	…
flashing_bootloadhid.md	…
fuse.txt	…
getting_started_docker.md	…
getting_started_github.md	Purge uGFX. (#14720 )	2021-10-07 10:57:48 +11:00
getting_started_introduction.md	[Docs] update git command and directory name of documents (#7619 )	2019-12-12 20:59:00 -08:00
getting_started_make_guide.md	…
gpio_control.md	…
hand_wire.md	…
hardware_drivers.md	Purge uGFX. (#14720 )	2021-10-07 10:57:48 +11:00
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.md	…
keycodes_basic.md	…
keycodes_magic.md	…
keycodes_us_ansi_shifted.md	…
keymap.md	…
mod_tap.md	…
newbs.md	…
newbs_building_firmware.md	…
newbs_building_firmware_configurator.md	…
newbs_building_firmware_workflow.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	…
one_shot_keys.md	…
other_eclipse.md	…
other_vscode.md	Fix VS code live share extension link (#21585 )	2023-07-23 09:07:17 +01: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	Add documentation for selecting an Arm MCU (#9046 )	2020-06-10 23:32:58 +01:00
porting_your_keyboard_to_qmk.md	…
power.txt	…
pr_checklist.md	Add reminder about format-json to PR Checklist (#22055 )	2023-09-23 01:18:11 -07:00
qmk.css	…
qmk_custom_dark.css	[Docs] Improve contrast for warnings in dark mode (#21928 )	2023-09-05 19:00:14 -07:00
qmk_custom_light.css	…
quantum_keycodes.md	…
quantum_painter.md	…
quantum_painter_lvgl.md	Lvgl rate control (#22049 )	2023-09-17 14:25:14 +10:00
quantum_painter_qff.md	…
quantum_painter_qgf.md	…
quantum_painter_rle.md	…
redirects.json	…
ref_functions.md	Remove legacy EEPROM clear keycodes (#18782 )	2022-10-20 12:20:07 +01:00
reference_configurator_support.md	Basic keycode overhaul (#14726 )	2021-11-03 22:22:17 -07:00
reference_glossary.md	Breaking changes changelog, 2023q3 version (#21848 )	2023-08-29 21:15:21 +10:00
reference_info_json.md	Complete RGB Matrix support for IS31FL3218 (#22004 )	2023-09-17 22:11:16 +10:00
reference_keymap_extras.md	…
serial_driver.md	…
spi_driver.md	…
squeezing_avr.md	[Doc] Improve magic keycode section (#21787 )	2023-08-22 21:52:52 -07:00
support.md	…
support_deprecation_policy.md	…
sw.js	…
syllabus.md	…
tap_hold.md	…
translating.md	…
uart_driver.md	…
understanding_qmk.md	…
unit_testing.md	…
usb_nkro.txt	…
ws2812_driver.md	…

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