History

kiilerix da6d6ce2e1 Some docs improvements (#15845 ) * docs: clarify in "Keymap Overview" what LAYOUT is and isn't It is not strictly necessary to use LAYOUT macros in keyboard.c, but it is a convenient abstraction of hardware internals, allowing focus on the physical keyboard layout. From the C source point of view LAYOUT is macro with a parameter list, which expands to a array of rows that each is an array with a keyboard scancode for each column. A macro parameter list is not an array, and even less a single array. Perhaps no big deal, but also no reason to give incorrect hints. * docs: update "Understanding QMK's Code" to current code structure introduced in `96e2b13d1d` This part of the documentation was no longer correct. I tried updating it, mainly copy editing and using github links to latest release. This is not trying to fix all problems, but just trying to fix some problems while reusing much of the old phrases and structure. * Update docs to use "qmk format-python"		2022-03-05 15:58:50 +11:00
..
ChangeLog	Changelog 2022q1 (#16380 )	2022-02-23 17:33:08 +00:00
gitbook/images	…
ja	Some docs improvements (#15845 )	2022-03-05 15:58:50 +11:00
zh-cn	[Docs] Address some typos (also in moonlander matrix.c) (#16248 )	2022-02-06 17:36:44 +00:00
.nojekyll	…
CNAME	…
README.md	…
_langs.md	…
_summary.md	Changelog 2022q1 (#16380 )	2022-02-23 17:33:08 +00:00
adc_driver.md	…
api_development_environment.md	…
api_development_overview.md	…
api_docs.md	[Docs] Address some typos (also in moonlander matrix.c) (#16248 )	2022-02-06 17:36:44 +00:00
api_overview.md	…
arm_debugging.md	…
audio_driver.md	…
breaking_changes.md	Changelog 2022q1 (#16380 )	2022-02-23 17:33:08 +00:00
breaking_changes_history.md	Changelog 2022q1 (#16380 )	2022-02-23 17:33:08 +00:00
breaking_changes_instructions.md	…
chibios_upgrade_instructions.md	…
cli.md	…
cli_commands.md	Initial pass at data driven new-keyboard subcommand (#12795 )	2022-02-09 06:03:30 +11:00
cli_configuration.md	…
cli_development.md	Some docs improvements (#15845 )	2022-03-05 15:58:50 +11:00
cli_tab_complete.md	…
coding_conventions_c.md	…
coding_conventions_python.md	…
compatible_microcontrollers.md	Add L432, L442. (#16016 )	2022-01-24 08:49:36 +11:00
config_options.md	Merge remote-tracking branch 'upstream/master' into develop	2022-02-09 16:00:09 +11:00
configurator_architecture.md	…
configurator_default_keymaps.md	…
configurator_diagram.drawio	…
configurator_diagram.svg	…
configurator_step_by_step.md	update the Chinese translation based on the latest English version (#14924 )	2022-01-18 18:24:02 +00:00
configurator_troubleshooting.md	…
contributing.md	update the Chinese translation based on the latest English version (#14924 )	2022-01-18 18:24:02 +00:00
custom_matrix.md	…
custom_quantum_functions.md	Point out that deferred execution needs to be enabled in rules.mk (#16196 )	2022-02-04 03:44:51 +00:00
data_driven_config.md	add 'info_config.h' into docs/hardware_keyboard_guidelines.md (#16247 )	2022-02-06 17:37:59 +00:00
documentation_best_practices.md	…
documentation_templates.md	…
driver_installation_zadig.md	…
easy_maker.md	update the Chinese translation based on the latest English version (#14924 )	2022-01-18 18:24:02 +00:00
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	…
feature_auto_shift.md	…
feature_backlight.md	…
feature_bluetooth.md	Rename `AdafruitBLE` to `BluefruitLE` (#16127 )	2022-01-30 17:29:42 +00:00
feature_bootmagic.md	…
feature_combo.md	New combo configuration options (#15083 )	2022-01-09 12:02:25 -08:00
feature_command.md	…
feature_debounce_type.md	…
feature_digitizer.md	…
feature_dip_switch.md	…
feature_dynamic_macros.md	…
feature_encoders.md	Sentence structure update (#16306 )	2022-02-10 16:16:01 +00:00
feature_grave_esc.md	Rename some Quantum keycodes (#15968 )	2022-01-22 03:34:15 +00:00
feature_haptic_feedback.md	Rip out old macro and action_function system (#16025 )	2022-01-24 21:22:20 +00:00
feature_hd44780.md	…
feature_joystick.md	…
feature_key_lock.md	…
feature_key_overrides.md	…
feature_layers.md	…
feature_layouts.md	…
feature_leader_key.md	[Docs] Update feature_leader_key.md (#16344 )	2022-02-21 09:08:36 -08:00
feature_led_indicators.md	Improve description of LED state data sync option (#16302 )	2022-02-10 18:12:42 +11:00
feature_led_matrix.md	Add RGB matrix & LED Matrix support for IS31FL3742A, IS31FL3743A, IS31FL3745, IS31FL3746A (#14989 )	2022-02-06 09:04:43 -08:00
feature_macros.md	[Docs] feature_macro.md: minor formatting fix (#16205 )	2022-02-05 08:15:21 +11:00
feature_midi.md	…
feature_mouse_keys.md	Merge remote-tracking branch 'origin/master' into develop	2022-02-05 11:45:18 +00:00
feature_oled_driver.md	[Docs] OLED documentation edits (#15977 )	2022-01-27 15:56:20 +00:00
feature_pointing_device.md	Remove default pointing device driver. (#16190 )	2022-02-05 14:29:15 +00:00
feature_programmable_button.md	…
feature_ps2_mouse.md	…
feature_rawhid.md	…
feature_rgb_matrix.md	[Docs] Anchor link correction in rgb matrix docs (#16460 )	2022-02-26 18:38:46 -08:00
feature_rgblight.md	Link WS2812 driver page from rgb feature docs (#16366 )	2022-02-27 01:50:44 +00:00
feature_sequencer.md	…
feature_space_cadet.md	…
feature_split_keyboard.md	Merge remote-tracking branch 'origin/master' into develop	2022-01-12 22:06:23 +00:00
feature_st7565.md	…
feature_stenography.md	…
feature_swap_hands.md	…
feature_tap_dance.md	[Docs] Address some typos (also in moonlander matrix.c) (#16248 )	2022-02-06 17:36:44 +00:00
feature_terminal.md	…
feature_thermal_printer.md	…
feature_unicode.md	…
feature_userspace.md	…
feature_velocikey.md	…
feature_wpm.md	…
flash_driver.md	Added external spi flash driver. (#15419 )	2022-02-11 20:26:16 +00:00
flashing.md	[Docs] Add commands to flashing docs (#16456 )	2022-02-26 17:35:10 -08: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	…
hand_wire.md	…
hardware_drivers.md	…
hardware_keyboard_guidelines.md	add 'info_config.h' into docs/hardware_keyboard_guidelines.md (#16247 )	2022-02-06 17:37:59 +00:00
how_a_matrix_works.md	…
how_keyboards_work.md	…
i2c_driver.md	…
index.html	Align docs to new-keyboard behaviour (#16357 )	2022-02-15 15:45:32 +11:00
internals_defines.md	…
internals_gpio_control.md	…
internals_input_callback_reg.md	…
internals_midi_device.md	…
internals_midi_device_setup_process.md	…
internals_midi_util.md	…
internals_send_functions.md	…
internals_sysex_tools.md	…
isp_flashing_guide.md	Add a warning about USBtinyISP limitations to the ISP flashing guide (#15898 )	2022-01-30 11:06:19 -08:00
keycodes.md	Rename some Quantum keycodes (#15968 )	2022-01-22 03:34:15 +00:00
keycodes_basic.md	…
keycodes_magic.md	…
keycodes_us_ansi_shifted.md	[Docs] Address some typos (also in moonlander matrix.c) (#16248 )	2022-02-06 17:36:44 +00:00
keymap.md	Some docs improvements (#15845 )	2022-03-05 15:58:50 +11:00
mod_tap.md	[Docs] Address some typos (also in moonlander matrix.c) (#16248 )	2022-02-06 17:36:44 +00:00
newbs.md	…
newbs_building_firmware.md	[Docs] Update newbs_building_firmware.md (#16333 )	2022-02-21 09:08:07 -08:00
newbs_building_firmware_configurator.md	…
newbs_flashing.md	[Docs] newbs_flashing.md: add link to build environment section (#15654 )	2022-01-10 16:54:22 -08:00
newbs_getting_started.md	fixed typo in docs/newbs_getting_started.md (#16501 )	2022-03-03 09:53:40 +00: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	Add Atom editor suggestion (#15969 )	2022-01-22 02:48:35 +11:00
newbs_testing_debugging.md	…
one_shot_keys.md	…
other_eclipse.md	[Docs] Address some typos (also in moonlander matrix.c) (#16248 )	2022-02-06 17:36:44 +00:00
other_vscode.md	[Docs] Address some typos (also in moonlander matrix.c) (#16248 )	2022-02-06 17:36:44 +00:00
platformdev_chibios_earlyinit.md	Fixes for bootloader refactor build failures (#15638 )	2022-01-06 06:55:46 +11:00
platformdev_selecting_arm_mcu.md	…
porting_your_keyboard_to_qmk.md	Align new-keyboard with recent schema updates (#16378 )	2022-02-16 20:58:40 +00:00
power.txt	…
pr_checklist.md	Update pr_checklist.md (#16484 )	2022-03-04 12:49:14 +11:00
proton_c_conversion.md	…
qmk.css	…
qmk_custom_dark.css	…
qmk_custom_light.css	…
quantum_keycodes.md	Rename some Quantum keycodes (#15968 )	2022-01-22 03:34:15 +00:00
redirects.json	…
ref_functions.md	…
reference_configurator_support.md	…
reference_glossary.md	…
reference_info_json.md	CLI: Parse USB device version BCD (#14580 )	2022-01-17 08:44:34 +11:00
reference_keymap_extras.md	…
serial_driver.md	…
spi_driver.md	…
squeezing_avr.md	Typo in squeezing_avr.md (#16506 )	2022-03-03 15:38:24 -08:00
support.md	…
sw.js	…
syllabus.md	…
tap_hold.md	…
translating.md	…
uart_driver.md	…
understanding_qmk.md	Some docs improvements (#15845 )	2022-03-05 15:58:50 +11:00
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