History

James Young fced377ac0 2020 May 30 Breaking Changes Update (#9215 ) * Branch point for 2020 May 30 Breaking Change * Migrate `ACTION_LAYER_TOGGLE` to `TG()` (#8954) * Migrate `ACTION_MODS_ONESHOT` to `OSM()` (#8957) * Migrate `ACTION_DEFAULT_LAYER_SET` to `DF()` (#8958) * Migrate `ACTION_LAYER_MODS` to `LM()` (#8959) * Migrate `ACTION_MODS_TAP_KEY` to `MT()` (#8968) * Convert V-USB usbdrv to a submodule (#8321) * Unify Tap Hold functions and documentation (#8348) * Changing board names to prevent confusion (#8412) * Move the Keyboardio Model01 to a keyboardio/ subdir (#8499) * Move spaceman keyboards (#8830) * Migrate miscellaneous `fn_actions` entries (#8977) * Migrate `ACTION_MODS_KEY` to chained mod keycodes (#8979) * Organizing my keyboards (plaid, tartan, ergoinu) (#8537) * Refactor Lily58 to use split_common (#6260) * Refactor zinc to use split_common (#7114) * Add a message if bin/qmk doesn't work (#9000) * Fix conflicting types for 'tfp_printf' (#8269) * Fixed RGB_DISABLE_AFTER_TIMEOUT to be seconds based & small internals cleanup (#6480) * Refactor and updates to TKC1800 code (#8472) * Switch to qmk forks for everything (#9019) * audio refactor: replace deprecated PLAY_NOTE_ARRAY (#8484) * Audio enable corrections (2/3) (#8903) * Split HHKB to ANSI and JP layouts and Add VIA support for each (#8582) * Audio enable corrections (Part 4) (#8974) * Fix typo from PR7114 (#9171) * Augment future branch Changelogs (#8978) * Revert "Branch point for 2020 May 30 Breaking Change"		2020-05-30 13:14:59 -07:00
..
ChangeLog	2020 May 30 Breaking Changes Update (#9215 )	2020-05-30 13:14:59 -07:00
de	Fix capitalisation of "GitHub" (#9184 )	2020-05-25 19:43:14 -07:00
es	Fix capitalisation of "GitHub" (#9184 )	2020-05-25 19:43:14 -07:00
fr-fr	Fix capitalisation of "GitHub" (#9184 )	2020-05-25 19:43:14 -07:00
gitbook/images	…
he-il	Fix capitalisation of "GitHub" (#9184 )	2020-05-25 19:43:14 -07:00
ja	2020 May 30 Breaking Changes Update (#9215 )	2020-05-30 13:14:59 -07:00
pt-br	Fix capitalisation of "GitHub" (#9184 )	2020-05-25 19:43:14 -07:00
ru-ru	Fix capitalisation of "GitHub" (#9184 )	2020-05-25 19:43:14 -07:00
zh-cn	2020 May 30 Breaking Changes Update (#9215 )	2020-05-30 13:14:59 -07:00
.nojekyll	…
CNAME	…
README.md	…
_langs.md	…
_summary.md	2020 May 30 Breaking Changes Update (#9215 )	2020-05-30 13:14:59 -07:00
adc_driver.md	…
api_development_environment.md	…
api_development_overview.md	…
api_docs.md	…
api_overview.md	…
arm_debugging.md	…
breaking_changes.md	2020 May 30 Breaking Changes Update (#9215 )	2020-05-30 13:14:59 -07:00
breaking_changes_instructions.md	2020 May 30 Breaking Changes Update (#9215 )	2020-05-30 13:14:59 -07:00
cli.md	Streamline the macos install process	2020-05-18 22:46:33 -07:00
cli_commands.md	[CLI] Add a subcommand for getting information about a keyboard (#8666 )	2020-05-26 13:05:41 -07:00
cli_configuration.md	Fix capitalisation of "GitHub" (#9184 )	2020-05-25 19:43:14 -07:00
cli_development.md	Fix capitalisation of "GitHub" (#9184 )	2020-05-25 19:43:14 -07:00
coding_conventions_c.md	…
coding_conventions_python.md	…
compatible_microcontrollers.md	…
config_options.md	Allow expanding from 8 to 32 RGB Lighting Layers (#8941 )	2020-05-13 21:39:05 +01:00
configurator_step_by_step.md	Fix capitalisation of "GitHub" (#9184 )	2020-05-25 19:43:14 -07:00
configurator_troubleshooting.md	…
contributing.md	…
custom_matrix.md	…
custom_quantum_functions.md	2020 May 30 Breaking Changes Update (#9215 )	2020-05-30 13:14:59 -07:00
documentation_best_practices.md	…
documentation_templates.md	…
driver_installation_zadig.md	…
eeprom_driver.md	Add SPI 25xx EEPROM support. (#8780 )	2020-05-19 10:34:00 +10:00
faq_build.md	Streamline the macos install process	2020-05-18 22:46:33 -07:00
faq_debug.md	…
faq_general.md	…
faq_keymap.md	…
feature_advanced_keycodes.md	…
feature_audio.md	…
feature_auto_shift.md	…
feature_backlight.md	…
feature_bluetooth.md	…
feature_bootmagic.md	…
feature_combo.md	…
feature_command.md	…
feature_debounce_type.md	…
feature_dip_switch.md	…
feature_dynamic_macros.md	…
feature_encoders.md	…
feature_grave_esc.md	…
feature_haptic_feedback.md	…
feature_hd44780.md	fixed typo for clear lcd screen function in hd44780 docs (#9086 )	2020-05-13 19:06:41 +01:00
feature_key_lock.md	…
feature_layers.md	…
feature_layouts.md	…
feature_leader_key.md	…
feature_led_matrix.md	…
feature_macros.md	…
feature_mouse_keys.md	…
feature_oled_driver.md	…
feature_pointing_device.md	Fixed the indentation of the sample code in feature_pointing_device docs (#9177 )	2020-05-23 23:57:59 +01:00
feature_ps2_mouse.md	…
feature_rawhid.md	Allow for overriding RAW endpoint usage page and ID. (#8834 )	2020-05-21 20:31:42 +10:00
feature_rgb_matrix.md	2020 May 30 Breaking Changes Update (#9215 )	2020-05-30 13:14:59 -07:00
feature_rgblight.md	Add query functions for RGB Light and RGB Matrix (#8960 )	2020-05-18 06:05:35 -07:00
feature_space_cadet.md	…
feature_split_keyboard.md	Update ARM split keyboard docs (#9160 )	2020-05-22 06:20:46 +10:00
feature_stenography.md	…
feature_swap_hands.md	One shot support for swap hands (#8590 )	2020-05-14 07:36:55 +10:00
feature_tap_dance.md	…
feature_terminal.md	…
feature_thermal_printer.md	…
feature_unicode.md	…
feature_userspace.md	Fix capitalisation of "GitHub" (#9184 )	2020-05-25 19:43:14 -07:00
feature_velocikey.md	…
feature_wpm.md	…
flashing.md	…
flashing_bootloadhid.md	…
fuse.txt	…
getting_started_docker.md	Reintegrate previous docker docs (#9084 )	2020-05-19 21:54:55 -07:00
getting_started_github.md	Fix capitalisation of "GitHub" (#9184 )	2020-05-25 19:43:14 -07:00
getting_started_introduction.md	…
getting_started_make_guide.md	…
getting_started_vagrant.md	…
hand_wire.md	…
hardware_avr.md	…
hardware_drivers.md	…
hardware_keyboard_guidelines.md	…
how_a_matrix_works.md	…
how_keyboards_work.md	…
i2c_driver.md	…
index.html	Add redirect for old getting started links (#8987 )	2020-05-02 04:29:55 +01:00
internals_defines.md	…
internals_gpio_control.md	add 'togglePin' convenience function (#8734 )	2020-04-29 04:04:29 -07:00
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	Improve stock bootloader list (#9067 )	2020-05-13 19:32:43 -07:00
keycodes.md	One shot support for swap hands (#8590 )	2020-05-14 07:36:55 +10:00
keycodes_basic.md	…
keycodes_us_ansi_shifted.md	…
keymap.md	[Docs] Clarify layer transparency keymap.md (#9081 )	2020-05-16 00:35:19 -07:00
mod_tap.md	…
newbs.md	…
newbs_building_firmware.md	…
newbs_building_firmware_configurator.md	…
newbs_flashing.md	[Docs] newbs_flashing.md: place bootloader instructions before Toolbox intro (#9077 )	2020-05-21 09:24:39 -07:00
newbs_getting_started.md	Fix capitalisation of "GitHub" (#9184 )	2020-05-25 19:43:14 -07: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	Fix capitalisation of "GitHub" (#9184 )	2020-05-25 19:43:14 -07:00
platformdev_chibios_earlyinit.md	…
power.txt	…
proton_c_conversion.md	Update ARM split keyboard docs (#9160 )	2020-05-22 06:20:46 +10:00
qmk.css	…
qmk_custom_dark.css	…
qmk_custom_light.css	…
quantum_keycodes.md	…
redirects.json	…
ref_functions.md	…
reference_configurator_support.md	…
reference_glossary.md	…
reference_info_json.md	…
reference_keymap_extras.md	Documentation for keymap_extras (#9194 )	2020-05-27 01:52:48 +01:00
serial_driver.md	Update ARM split keyboard docs (#9160 )	2020-05-22 06:20:46 +10:00
spi_driver.md	Add SPI master for ChibiOS/ARM. (#8779 )	2020-04-29 14:01:20 +10:00
support.md	Fix capitalisation of "GitHub" (#9184 )	2020-05-25 19:43:14 -07:00
sw.js	…
syllabus.md	…
tap_hold.md	2020 May 30 Breaking Changes Update (#9215 )	2020-05-30 13:14:59 -07:00
translating.md	…
understanding_qmk.md	…
unit_testing.md	Edit Unit Testing Documentation (#8961 )	2020-04-29 07:39:08 +10:00
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

Totally new to QMK? There are two ways to get started:

Basic: QMK Configurator
- Just select your keyboard from the dropdown and program your keyboard.
- We have an introductory video you can watch.
- There is also an overview document you can read.
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