History

Zach White d9785ec313 Improve the compile and flash subcommands (#11334 ) * add support for --clean to compile and flash * compile standalone JSON keymaps without polluting the tree * Add support for passing environment vars to make * make flake8 happy * document changes to qmk compile and flash * add -e support to json export compiling * Fix python 3.6 * honor $MAKE * add support for parallel builds		2021-01-16 15:13:04 -08:00
..
ChangeLog	Ensure single newline at EOF for core files (#11310 )	2020-12-28 04:36:32 +11:00
de	Normalise include statements in core code (#11153 )	2020-12-11 13:45:24 +11:00
es	Ensure single newline at EOF for core files (#11310 )	2020-12-28 04:36:32 +11:00
fr-fr	Normalise include statements in core code (#11153 )	2020-12-11 13:45:24 +11:00
gitbook/images	…
he-il	Ensure single newline at EOF for core files (#11310 )	2020-12-28 04:36:32 +11:00
ja	[Docs] Japanese translation of feature_rawhid.md (#10858 )	2021-01-06 14:08:21 +09:00
ko-kr	…
pt-br	…
ru-ru	…
zh-cn	Normalise include statements in core code (#11153 )	2020-12-11 13:45:24 +11:00
.nojekyll	…
CNAME	…
README.md	[Docs] Update links in main README.md (#11284 )	2020-12-22 22:37:01 -08:00
_langs.md	…
_summary.md	…
adc_driver.md	…
api_development_environment.md	…
api_development_overview.md	…
api_docs.md	…
api_overview.md	…
arm_debugging.md	…
breaking_changes.md	…
breaking_changes_instructions.md	2020 May 30 Breaking Changes Update (#9215 )	2020-05-30 13:14:59 -07:00
cli.md	…
cli_commands.md	Improve the compile and flash subcommands (#11334 )	2021-01-16 15:13:04 -08:00
cli_configuration.md	…
cli_development.md	…
coding_conventions_c.md	…
coding_conventions_python.md	…
compatible_microcontrollers.md	…
config_options.md	Normalise include statements in core code (#11153 )	2020-12-11 13:45:24 +11:00
configurator_default_keymaps.md	[Docs] add "Adding Default Keymaps to QMK Configurator" doc (#10049 )	2020-10-18 03:50:32 +11:00
configurator_step_by_step.md	…
configurator_troubleshooting.md	Polish Configurator section	2020-03-05 16:00:10 -08:00
contributing.md	…
custom_matrix.md	…
custom_quantum_functions.md	…
documentation_best_practices.md	…
documentation_templates.md	…
driver_installation_zadig.md	Zadig docs: add APM32 device name (#11356 )	2020-12-30 16:35:06 +00:00
eeprom_driver.md	Add i2c 24LC64 eeprom (#11200 )	2020-12-14 05:50:50 +11:00
faq_build.md	…
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	Ensure single newline at EOF for core files (#11310 )	2020-12-28 04:36:32 +11:00
feature_dip_switch.md	…
feature_dynamic_macros.md	…
feature_encoders.md	…
feature_grave_esc.md	…
feature_haptic_feedback.md	2020 November 28 Breaking Changes Update (#11053 )	2020-11-28 12:02:18 -08:00
feature_hd44780.md	fixed typo for clear lcd screen function in hd44780 docs (#9086 )	2020-05-13 19:06:41 +01:00
feature_joystick.md	…
feature_key_lock.md	…
feature_layers.md	…
feature_layouts.md	…
feature_leader_key.md	…
feature_led_indicators.md	…
feature_led_matrix.md	…
feature_macros.md	Typo fix: Useful function -> Useful Functions (#11342 )	2020-12-30 01:32:30 +09:00
feature_mouse_keys.md	…
feature_oled_driver.md	…
feature_pointing_device.md	…
feature_ps2_mouse.md	…
feature_rawhid.md	Updated Raw HID docs to clarify packet/report length (#11211 )	2020-12-23 08:04:55 +11:00
feature_rgb_matrix.md	allow customizing decrease delay of rgb heatmap (#11322 )	2021-01-14 11:29:00 -08:00
feature_rgblight.md	[Docs] Update feature_rgblight.md (#11363 )	2021-01-10 23:05:11 -08:00
feature_sequencer.md	Ensure single newline at EOF for core files (#11310 )	2020-12-28 04:36:32 +11:00
feature_space_cadet.md	…
feature_split_keyboard.md	…
feature_stenography.md	Ensure single newline at EOF for core files (#11310 )	2020-12-28 04:36:32 +11:00
feature_swap_hands.md	…
feature_tap_dance.md	…
feature_terminal.md	…
feature_thermal_printer.md	…
feature_unicode.md	Fix documentation so UCIS example compiles. (#11541 )	2021-01-14 11:11:59 +11:00
feature_userspace.md	Normalise include statements in core code (#11153 )	2020-12-11 13:45:24 +11:00
feature_velocikey.md	…
feature_wpm.md	…
flashing.md	Add `st-flash` flash target (#9964 )	2020-08-29 14:30:02 -07:00
flashing_bootloadhid.md	Install bootloadHid as part of qmk_install (#7463 )	2019-11-28 15:29:11 +00:00
fuse.txt	Ensure single newline at EOF for core files (#11310 )	2020-12-28 04:36:32 +11:00
getting_started_docker.md	…
getting_started_github.md	…
getting_started_introduction.md	…
getting_started_make_guide.md	…
getting_started_vagrant.md	…
hand_wire.md	[Docs] Fix typo in hand_wire.md (#11297 )	2021-01-01 17:36:17 -08:00
hardware_avr.md	Fix documentation of `lsusb` behaviour (#10903 )	2021-01-10 21:48:29 -08:00
hardware_drivers.md	…
hardware_keyboard_guidelines.md	…
how_a_matrix_works.md	…
how_keyboards_work.md	…
i2c_driver.md	…
index.html	Simplify the visual flow of the getting started page (#11316 )	2020-12-27 16:56:10 +00:00
internals_defines.md	rename api docs to internals	2018-03-26 11:43:37 -07:00
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	…
keycodes.md	Update keycode docs (#11343 )	2020-12-30 07:51:36 +11:00
keycodes_basic.md	Update keycode docs (#11343 )	2020-12-30 07:51:36 +11:00
keycodes_us_ansi_shifted.md	…
keymap.md	…
mod_tap.md	…
newbs.md	…
newbs_building_firmware.md	…
newbs_building_firmware_configurator.md	…
newbs_flashing.md	…
newbs_getting_started.md	Fix AUR package name (#11416 )	2021-01-09 11:37:42 +11:00
newbs_git_best_practices.md	…
newbs_git_resolving_merge_conflicts.md	…
newbs_git_resynchronize_a_branch.md	[Docs] Fix minor differences in docs/newbs_git_resynchronize_a_branch.md (#7728 )	2019-12-27 14:31:23 -08:00
newbs_git_using_your_master_branch.md	…
newbs_learn_more_resources.md	…
newbs_testing_debugging.md	Normalise include statements in core code (#11153 )	2020-12-11 13:45:24 +11:00
one_shot_keys.md	Update one_shot_keys.md (#10917 )	2020-11-18 21:31:21 +00:00
other_eclipse.md	…
other_vscode.md	…
platformdev_chibios_earlyinit.md	Ensure single newline at EOF for core files (#11310 )	2020-12-28 04:36:32 +11:00
platformdev_selecting_arm_mcu.md	…
power.txt	…
pr_checklist.md	…
proton_c_conversion.md	…
qmk.css	…
qmk_custom_dark.css	Simplify the visual flow of the getting started page (#11316 )	2020-12-27 16:56:10 +00:00
qmk_custom_light.css	Simplify the visual flow of the getting started page (#11316 )	2020-12-27 16:56:10 +00:00
quantum_keycodes.md	…
redirects.json	…
ref_functions.md	…
reference_configurator_support.md	…
reference_glossary.md	…
reference_info_json.md	…
reference_keymap_extras.md	Added mac variant of portuguese keymap extras (#11260 )	2020-12-29 19:40:58 -08:00
serial_driver.md	Update ARM split keyboard docs (#9160 )	2020-05-22 06:20:46 +10:00
spi_driver.md	adds support for the atmega328 (#9043 )	2020-06-10 22:23:11 +01:00
support.md	…
sw.js	…
syllabus.md	…
tap_hold.md	…
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	Add BGR byte order for WS2812 drivers (#11562 )	2021-01-16 08:42:30 +11: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

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