My local repo of qmk firmware.

History

souvlakeeb 3f45fd4924 Fix serial_driver.md list item numbering (#19819 )		2 years ago
..
ChangeLog	Minor cleanup to breaking/checklist docs. (#19596 )	2 years ago
gitbook/images	…
internals	Move Doxygen docs to subdirectory (#16561 )	3 years ago
ja	[Docs] Remove broken link (#19321 )	2 years ago
zh-cn	Macro keycode name refactoring (#18958 )	3 years ago
.nojekyll	…
CNAME	…
README.md	…
_langs.md	Remove stale docs translations (#15737 )	3 years ago
_summary.md	Stub next develop dates	3 years ago
adc_driver.md	…
api_development_environment.md	…
api_development_overview.md	…
api_docs.md	2022 Nov 26 changelog. (#19164 )	2 years ago
api_overview.md	…
arm_debugging.md	…
audio_driver.md	[Core] Adjust PWM hardware audio driver for RP2040 (#17723 )	3 years ago
breaking_changes.md	Minor cleanup to breaking/checklist docs. (#19596 )	2 years ago
breaking_changes_history.md	Stub next develop dates	3 years ago
breaking_changes_instructions.md	…
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 )	2 years ago
cli.md	…
cli_commands.md	docs: some typos (#18582 )	3 years ago
cli_configuration.md	…
cli_development.md	docs: some typos (#18582 )	3 years ago
cli_tab_complete.md	Add Zsh note for tab complete (#17226 )	3 years ago
coding_conventions_c.md	docs: some typos (#18582 )	3 years ago
coding_conventions_python.md	docs: some typos (#18582 )	3 years ago
compatible_microcontrollers.md	Tentative Teensy 3.5 support (#14420 )	3 years ago
config_options.md	Merge remote-tracking branch 'origin/master' into develop	3 years ago
configurator_architecture.md	…
configurator_default_keymaps.md	Macro keycode name refactoring (#18958 )	3 years ago
configurator_diagram.drawio	…
configurator_diagram.svg	…
configurator_step_by_step.md	update the Chinese translation based on the latest English version (#14924 )	3 years ago
configurator_troubleshooting.md	…
contributing.md	Minor cleanup to breaking/checklist docs. (#19596 )	2 years ago
custom_matrix.md	Make debounce() signal changes in the cooked matrix as return value (#17554 )	3 years ago
custom_quantum_functions.md	[Docs] Extract 'Layer Change Code' and EEPROM (#18174 )	3 years ago
data_driven_config.md	Format DD mappings and schemas (#18924 )	3 years ago
documentation_best_practices.md	…
documentation_templates.md	[Docs] Touch up documentation templates & porting keyboard docs (#19573 )	2 years ago
driver_installation_zadig.md	[Docs] RESET -> QK_BOOT (#18365 )	3 years ago
easy_maker.md	update the Chinese translation based on the latest English version (#14924 )	3 years ago
eeprom_driver.md	RP2040 emulated EEPROM. (#17519 )	3 years ago
faq_build.md	…
faq_debug.md	Remove legacy Debug keycode (#18769 )	3 years ago
faq_general.md	…
faq_keymap.md	Keymap FAQ updates (#17130 )	3 years ago
faq_misc.md	[Docs] RESET -> QK_BOOT (#18365 )	3 years ago
feature_advanced_keycodes.md	[Docs] Extract 'Layer Change Code' and EEPROM (#18174 )	3 years ago
feature_audio.md	Align audio keycode names (#18962 )	3 years ago
feature_auto_shift.md	Normalise Auto Shift keycodes (#18892 )	3 years ago
feature_autocorrect.md	Clean up `qmk generate-autocorrect-data` (#19710 )	2 years ago
feature_backlight.md	Reworked backlight keycodes. (#18961 )	3 years ago
feature_bluetooth.md	Normalise output selection (Bluetooth) keycodes (#19004 )	3 years ago
feature_bootmagic.md	Add split keyboard example for Bootmagic Lite (#16349 )	3 years ago
feature_caps_word.md	Deprecate `CAPS_WORD`/`CAPSWRD` for `CW_TOGG` (#18834 )	3 years ago
feature_combo.md	[Docs] Combos example consistently uses A B keys (#19792 )	2 years ago
feature_command.md	…
feature_converters.md	Add Bonsai C4 as a platform board file (#18901 )	3 years ago
feature_debounce_type.md	Add sym_defer_pr debouncer type (#14948 )	3 years ago
feature_digitizer.md	Digitizer feature improvements (#19034 )	3 years ago
feature_dip_switch.md	…
feature_dynamic_macros.md	Normalise Dynamic Macro keycodes (#18939 )	3 years ago
feature_eeprom.md	Remove rgblight_list.h (#18878 )	3 years ago
feature_encoders.md	docs: add a note about reflashing both halves for encoder resolution (#19162 )	2 years ago
feature_grave_esc.md	Rename some Quantum keycodes (#15968 )	3 years ago
feature_haptic_feedback.md	Align haptic feedback keycode names (#18964 )	3 years ago
feature_hd44780.md	HD44780 driver rework (#16370 )	3 years ago
feature_joystick.md	[Docs] Fix `JOYSTICK_AXIS_COUNT` name in docs (#19605 )	2 years ago
feature_key_lock.md	Merge remote-tracking branch 'origin/master' into develop	3 years ago
feature_key_overrides.md	Deprecate `KEY_OVERRIDE_` keycodes for `KO_` (#18843 )	3 years ago
feature_layers.md	Update documentation for LM(layer, mod) (#19284 )	2 years ago
feature_layouts.md	…
feature_leader_key.md	Highlight inclusion of extern macro (#19614 )	2 years ago
feature_led_indicators.md	quantum: led: split out led_update_ports() for customization of led behaviour (#14452 )	3 years ago
feature_led_matrix.md	docs: Fix IS31FL3743A driver name (#19518 )	2 years ago
feature_macros.md	Macro keycode name refactoring (#18958 )	3 years ago
feature_midi.md	changed the undefined ON and OFF parameters to thedefined constant (#19772 )	2 years ago
feature_mouse_keys.md	add "inertia" mode for mouse keys (#18774 )	3 years ago
feature_oled_driver.md	Update OLED doc (#19213 )	2 years ago
feature_pointing_device.md	Fix references to `mouse_report_t` (which doesnt exist) (#19107 )	3 years ago
feature_programmable_button.md	Normalise Joystick and Programmable Button keycodes (#18832 )	3 years ago
feature_ps2_mouse.md	[Core] Rework PS/2 driver selection (#17892 )	3 years ago
feature_rawhid.md	…
feature_rgb_matrix.md	Use consistent highlight format (#19619 )	2 years ago
feature_rgblight.md	Fix description for selectively disabling animations (#19374 )	2 years ago
feature_secure.md	Deprecate `SECURE_` keycodes for `QK_SECURE_` (#18847 )	3 years ago
feature_send_string.md	Feature-ify Send String (#17275 )	3 years ago
feature_sequencer.md	…
feature_space_cadet.md	Normalise Space Cadet keycodes (#18864 )	3 years ago
feature_split_keyboard.md	Update handedness by define examples (#19687 )	2 years ago
feature_st7565.md	…
feature_stenography.md	Rename postprocess_steno_user → post_process_steno_user (#17823 )	3 years ago
feature_swap_hands.md	Add support for encoder mapping. (#13286 )	3 years ago
feature_tap_dance.md	[Docs] Remove broken link (#19321 )	2 years ago
feature_unicode.md	Fixes unicode_map declaration example (#19450 )	2 years ago
feature_userspace.md	Enable CLI flashing via mdloader (#14729 )	4 years ago
feature_velocikey.md	Deprecate `VLK_TOG` for `VK_TOGG` (#18807 )	3 years ago
feature_wpm.md	Fixes potential wpm sampling overflow, along with code comment fixes (#15277 )	3 years ago
flash_driver.md	Added external spi flash driver. (#15419 )	3 years ago
flashing.md	[Docs] RESET -> QK_BOOT (#18365 )	3 years ago
flashing_bootloadhid.md	[Docs] RESET -> QK_BOOT (#18365 )	3 years ago
fuse.txt	…
getting_started_docker.md	…
getting_started_github.md	Purge uGFX. (#14720 )	4 years ago
getting_started_introduction.md	…
getting_started_make_guide.md	Add support for deferred executors. (#14859 )	4 years ago
getting_started_vagrant.md	…
gpio_control.md	Move Doxygen docs to subdirectory (#16561 )	3 years ago
hand_wire.md	Improve importer workflow (#17707 )	3 years ago
hardware_drivers.md	Purge uGFX. (#14720 )	4 years ago
hardware_keyboard_guidelines.md	Add docs to cover recent LAYOUT_all lint checks (#19393 )	2 years ago
how_a_matrix_works.md	…
how_keyboards_work.md	docs: reflect systemd's change in language (#17322 )	3 years ago
i2c_driver.md	Fix i2c driver doc: Incorrect name (#16898 )	3 years ago
index.html	Fix anchors with <code> in table of content (#15169 )	3 years ago
isp_flashing_guide.md	ISP flashing guide: add instructions for flashing STM32duino bootloader (#16568 )	3 years ago
keycodes.md	Fix RWIN typo within keycode list (#19155 )	2 years ago
keycodes_basic.md	Chromeos keycodes (#18212 )	3 years ago
keycodes_magic.md	PoC: Swap Escape and Caps (#16336 )	3 years ago
keycodes_us_ansi_shifted.md	[Docs] Address some typos (also in moonlander matrix.c) (#16248 )	3 years ago
keymap.md	Remove legacy international keycodes (#18588 )	3 years ago
mod_tap.md	[Docs] Address some typos (also in moonlander matrix.c) (#16248 )	3 years ago
newbs.md	…
newbs_building_firmware.md	Fix typo (#18526 )	3 years ago
newbs_building_firmware_configurator.md	…
newbs_building_firmware_workflow.md	[Docs] Building with GitHub Userspace (#16271 )	3 years ago
newbs_flashing.md	Add note about qmk doctor in newbs_flashing.md (#15688 )	3 years ago
newbs_getting_started.md	Attempt to discourage manual MSYS install for new users (#17556 )	3 years ago
newbs_git_best_practices.md	…
newbs_git_resolving_merge_conflicts.md	…
newbs_git_resynchronize_a_branch.md	[Docs] Resynchronizing Your Branch including submodules (#19268 )	2 years ago
newbs_git_using_your_master_branch.md	…
newbs_learn_more_resources.md	[Docs] Refactor code examples (#18003 )	3 years ago
newbs_testing_debugging.md	…
one_shot_keys.md	fix typo (#19189 )	2 years ago
other_eclipse.md	[Docs] Address some typos (also in moonlander matrix.c) (#16248 )	3 years ago
other_vscode.md	Update other_vscode.md (#17317 )	3 years ago
platformdev_blackpill_f4x1.md	Docs: typo fixes in platformdev_blackpill_f4x1.md (#19635 )	2 years ago
platformdev_chibios_earlyinit.md	[Docs] RESET -> QK_BOOT (#18365 )	3 years ago
platformdev_proton_c.md	Add converter docs (#17593 )	3 years ago
platformdev_rp2040.md	[Core] Adjust PWM hardware audio driver for RP2040 (#17723 )	3 years ago
platformdev_selecting_arm_mcu.md	…
porting_your_keyboard_to_qmk.md	[Docs] Touch up documentation templates & porting keyboard docs (#19573 )	2 years ago
power.txt	…
pr_checklist.md	Minor cleanup to breaking/checklist docs. (#19596 )	2 years ago
qmk.css	…
qmk_custom_dark.css	…
qmk_custom_light.css	…
quantum_keycodes.md	Add ability to enter bootloader mode from `QK_MAKE` (#17745 )	3 years ago
quantum_painter.md	Add raw output option for QGF/QFF files. (#18998 )	3 years ago
quantum_painter_qff.md	Quantum Painter (#10174 )	3 years ago
quantum_painter_qgf.md	Quantum Painter (#10174 )	3 years ago
quantum_painter_rle.md	Quantum Painter (#10174 )	3 years ago
redirects.json	…
ref_functions.md	Remove legacy EEPROM clear keycodes (#18782 )	3 years ago
reference_configurator_support.md	Basic keycode overhaul (#14726 )	4 years ago
reference_glossary.md	…
reference_info_json.md	Fix headers in info.json reference (#19202 )	2 years ago
reference_keymap_extras.md	Rename keymap_extras headers for consistency (#16939 )	3 years ago
serial_driver.md	Fix serial_driver.md list item numbering (#19819 )	2 years ago
spi_driver.md	…
squeezing_avr.md	Add Elite-Pi converter (#18236 )	3 years ago
support.md	…
sw.js	…
syllabus.md	[Docs] Squeezing space out of AVR (#15243 )	4 years ago
tap_hold.md	Align dynamic tapping term keycode names (#18963 )	3 years ago
translating.md	…
uart_driver.md	Update UART driver API (#14839 )	4 years ago
understanding_qmk.md	Update understanding_qmk.md (#19664 )	2 years ago
unit_testing.md	Remove SERIAL_LINK feature (#14727 )	4 years ago
usb_nkro.txt	…
ws2812_driver.md	[Core] Allow custom timings for WS2812 PIO driver (#18006 )	3 years ago

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