Open-source keyboard firmware for Atmel AVR and Arm USB families Including hardware based encryption

Go to file

drashna 8f61ef471e Deploying to gh-pages from master @ `b1f8622513` 🚀		2022-02-21 17:10:48 +00:00
ChangeLog	Deploying to gh-pages from master @ `88fe5c16a5` 🚀	2021-11-28 00:12:20 +00:00
gitbook/images	Deploying to gh-pages from master @ `aae3b35c0f` 🚀	2020-11-10 15:02:44 +00:00
ja	Deploying to gh-pages from master @ `14f886d03b` 🚀	2022-02-06 17:38:19 +00:00
zh-cn	Deploying to gh-pages from master @ `14f886d03b` 🚀	2022-02-06 17:38:19 +00:00
.nojekyll	Deploying to gh-pages from master @ `aae3b35c0f` 🚀	2020-11-10 15:02:44 +00:00
CNAME	Deploying to gh-pages from master @ `aae3b35c0f` 🚀	2020-11-10 15:02:44 +00:00
README.md	Deploying to gh-pages from master @ `4e8166750b` 🚀	2021-01-20 18:48:18 +00:00
_langs.md	Deploying to gh-pages from master @ `1c1e6fa47d` 🚀	2022-01-05 02:13:02 +00:00
_summary.md	Deploying to gh-pages from master @ `88fe5c16a5` 🚀	2021-11-28 00:12:20 +00:00
adc_driver.md	Deploying to gh-pages from master @ `1646c0f26c` 🚀	2021-05-29 21:40:23 +00:00
api_development_environment.md	Deploying to gh-pages from master @ `aae3b35c0f` 🚀	2020-11-10 15:02:44 +00:00
api_development_overview.md	Deploying to gh-pages from master @ `aae3b35c0f` 🚀	2020-11-10 15:02:44 +00:00
api_docs.md	Deploying to gh-pages from master @ `14f886d03b` 🚀	2022-02-06 17:38:19 +00:00
api_overview.md	Deploying to gh-pages from master @ `92a787ca4c` 🚀	2021-01-30 11:02:49 +00:00
arm_debugging.md	Deploying to gh-pages from master @ `aae3b35c0f` 🚀	2020-11-10 15:02:44 +00:00
audio_driver.md	Deploying to gh-pages from master @ `88fe5c16a5` 🚀	2021-11-28 00:12:20 +00:00
breaking_changes.md	Deploying to gh-pages from master @ `99ec5e39cf` 🚀	2021-11-28 02:01:30 +00:00
breaking_changes_history.md	Deploying to gh-pages from master @ `88fe5c16a5` 🚀	2021-11-28 00:12:20 +00:00
breaking_changes_instructions.md	Deploying to gh-pages from master @ `aae3b35c0f` 🚀	2020-11-10 15:02:44 +00:00
chibios_upgrade_instructions.md	Deploying to gh-pages from master @ `88fe5c16a5` 🚀	2021-11-28 00:12:20 +00:00
cli.md	Deploying to gh-pages from master @ `aae3b35c0f` 🚀	2020-11-10 15:02:44 +00:00
cli_commands.md	Deploying to gh-pages from master @ `14f886d03b` 🚀	2022-02-06 17:38:19 +00:00
cli_configuration.md	Deploying to gh-pages from master @ `aae3b35c0f` 🚀	2020-11-10 15:02:44 +00:00
cli_development.md	Deploying to gh-pages from master @ `88fe5c16a5` 🚀	2021-11-28 00:12:20 +00:00
cli_tab_complete.md	Deploying to gh-pages from master @ `0002acd4a3` 🚀	2021-10-24 22:34:30 +00:00
coding_conventions_c.md	Deploying to gh-pages from master @ `92a787ca4c` 🚀	2021-01-30 11:02:49 +00:00
coding_conventions_python.md	Deploying to gh-pages from master @ `fefd7fdc51` 🚀	2021-11-04 21:16:33 +00:00
compatible_microcontrollers.md	Deploying to gh-pages from master @ `0df93ec2f9` 🚀	2021-12-09 03:51:03 +00:00
config_options.md	Deploying to gh-pages from master @ `efdaa7f972` 🚀	2022-02-09 04:52:53 +00:00
configurator_architecture.md	Deploying to gh-pages from master @ `9a0118c603` 🚀	2021-08-10 14:50:25 +00:00
configurator_default_keymaps.md	Deploying to gh-pages from master @ `88fe5c16a5` 🚀	2021-11-28 00:12:20 +00:00
configurator_diagram.drawio	Deploying to gh-pages from master @ `9a0118c603` 🚀	2021-08-10 14:50:25 +00:00
configurator_diagram.svg	Deploying to gh-pages from master @ `9a0118c603` 🚀	2021-08-10 14:50:25 +00:00
configurator_step_by_step.md	Deploying to gh-pages from master @ `f6a7f4d4ac` 🚀	2022-01-18 18:26:21 +00:00
configurator_troubleshooting.md	Deploying to gh-pages from master @ `aae3b35c0f` 🚀	2020-11-10 15:02:44 +00:00
contributing.md	Deploying to gh-pages from master @ `f6a7f4d4ac` 🚀	2022-01-18 18:26:21 +00:00
custom_matrix.md	Deploying to gh-pages from master @ `88fe5c16a5` 🚀	2021-11-28 00:12:20 +00:00
custom_quantum_functions.md	Deploying to gh-pages from master @ `3403f5813c` 🚀	2022-02-04 03:46:48 +00:00
data_driven_config.md	Deploying to gh-pages from master @ `87199eb2f5` 🚀	2022-02-06 17:39:30 +00:00
documentation_best_practices.md	Deploying to gh-pages from master @ `aae3b35c0f` 🚀	2020-11-10 15:02:44 +00:00
documentation_templates.md	Deploying to gh-pages from master @ `92a787ca4c` 🚀	2021-01-30 11:02:49 +00:00
driver_installation_zadig.md	Deploying to gh-pages from master @ `88fe5c16a5` 🚀	2021-11-28 00:12:20 +00:00
easy_maker.md	Deploying to gh-pages from master @ `f6a7f4d4ac` 🚀	2022-01-18 18:26:21 +00:00
eeprom_driver.md	Deploying to gh-pages from master @ `f061ca4974` 🚀	2021-08-28 22:38:06 +00:00
faq_build.md	Deploying to gh-pages from master @ `92a787ca4c` 🚀	2021-01-30 11:02:49 +00:00
faq_debug.md	Deploying to gh-pages from master @ `3f1f60cbf9` 🚀	2021-12-22 14:29:00 +00:00
faq_general.md	Deploying to gh-pages from master @ `d6701b3ac7` 🚀	2021-01-23 21:43:19 +00:00
faq_keymap.md	Deploying to gh-pages from master @ `88fe5c16a5` 🚀	2021-11-28 00:12:20 +00:00
faq_misc.md	Deploying to gh-pages from master @ `88fe5c16a5` 🚀	2021-11-28 00:12:20 +00:00
feature_advanced_keycodes.md	Deploying to gh-pages from master @ `92dd1b977b` 🚀	2021-06-22 02:43:23 +00:00
feature_audio.md	Deploying to gh-pages from master @ `f061ca4974` 🚀	2021-08-28 22:38:06 +00:00
feature_auto_shift.md	Deploying to gh-pages from master @ `88fe5c16a5` 🚀	2021-11-28 00:12:20 +00:00
feature_backlight.md	Deploying to gh-pages from master @ `88fe5c16a5` 🚀	2021-11-28 00:12:20 +00:00
feature_bluetooth.md	Deploying to gh-pages from master @ `8d604e707b` 🚀	2021-12-14 04:57:26 +00:00
feature_bootmagic.md	Deploying to gh-pages from master @ `88fe5c16a5` 🚀	2021-11-28 00:12:20 +00:00
feature_combo.md	Deploying to gh-pages from master @ `b384599663` 🚀	2021-12-27 03:11:32 +00:00
feature_command.md	Deploying to gh-pages from master @ `f061ca4974` 🚀	2021-08-28 22:38:06 +00:00
feature_debounce_type.md	Deploying to gh-pages from master @ `f061ca4974` 🚀	2021-08-28 22:38:06 +00:00
feature_digitizer.md	Deploying to gh-pages from master @ `88fe5c16a5` 🚀	2021-11-28 00:12:20 +00:00
feature_dip_switch.md	Deploying to gh-pages from master @ `f061ca4974` 🚀	2021-08-28 22:38:06 +00:00
feature_dynamic_macros.md	Deploying to gh-pages from master @ `aae3b35c0f` 🚀	2020-11-10 15:02:44 +00:00
feature_encoders.md	Deploying to gh-pages from master @ `f662939037` 🚀	2022-02-10 16:18:08 +00:00
feature_grave_esc.md	Deploying to gh-pages from master @ `88fe5c16a5` 🚀	2021-11-28 00:12:20 +00:00
feature_haptic_feedback.md	Deploying to gh-pages from master @ `88fe5c16a5` 🚀	2021-11-28 00:12:20 +00:00
feature_hd44780.md	Deploying to gh-pages from master @ `aae3b35c0f` 🚀	2020-11-10 15:02:44 +00:00
feature_joystick.md	Deploying to gh-pages from master @ `88fe5c16a5` 🚀	2021-11-28 00:12:20 +00:00
feature_key_lock.md	Deploying to gh-pages from master @ `aae3b35c0f` 🚀	2020-11-10 15:02:44 +00:00
feature_key_overrides.md	Deploying to gh-pages from master @ `88fe5c16a5` 🚀	2021-11-28 00:12:20 +00:00
feature_layers.md	Deploying to gh-pages from master @ `88fe5c16a5` 🚀	2021-11-28 00:12:20 +00:00
feature_layouts.md	Deploying to gh-pages from master @ `88fe5c16a5` 🚀	2021-11-28 00:12:20 +00:00
feature_leader_key.md	Deploying to gh-pages from master @ `b1f8622513` 🚀	2022-02-21 17:10:48 +00:00
feature_led_indicators.md	Deploying to gh-pages from master @ `3e5cb1da0f` 🚀	2022-02-10 07:14:21 +00:00
feature_led_matrix.md	Deploying to gh-pages from master @ `ad09160b03` 🚀	2022-01-21 14:19:19 +00:00
feature_macros.md	Deploying to gh-pages from master @ `f52cc210b8` 🚀	2022-02-04 21:17:02 +00:00
feature_midi.md	Deploying to gh-pages from master @ `88fe5c16a5` 🚀	2021-11-28 00:12:20 +00:00
feature_mouse_keys.md	Deploying to gh-pages from master @ `10fda3ec8e` 🚀	2022-02-05 11:46:28 +00:00
feature_oled_driver.md	Deploying to gh-pages from master @ `0f0e90971b` 🚀	2022-01-27 15:58:13 +00:00
feature_pointing_device.md	Deploying to gh-pages from master @ `be06ef6af5` 🚀	2022-01-20 20:15:40 +00:00
feature_programmable_button.md	Deploying to gh-pages from master @ `88fe5c16a5` 🚀	2021-11-28 00:12:20 +00:00
feature_ps2_mouse.md	Deploying to gh-pages from master @ `88fe5c16a5` 🚀	2021-11-28 00:12:20 +00:00
feature_rawhid.md	Deploying to gh-pages from master @ `88fe5c16a5` 🚀	2021-11-28 00:12:20 +00:00
feature_rgb_matrix.md	Deploying to gh-pages from master @ `7a0b07f84b` 🚀	2022-02-06 05:18:10 +00:00
feature_rgblight.md	Deploying to gh-pages from master @ `7a0b07f84b` 🚀	2022-02-06 05:18:10 +00:00
feature_sequencer.md	Deploying to gh-pages from master @ `1b7b72c0e9` 🚀	2020-12-27 17:38:14 +00:00
feature_space_cadet.md	Deploying to gh-pages from master @ `92a787ca4c` 🚀	2021-01-30 11:02:49 +00:00
feature_split_keyboard.md	Deploying to gh-pages from master @ `c4b0a06c79` 🚀	2022-01-12 22:07:34 +00:00
feature_st7565.md	Deploying to gh-pages from master @ `f061ca4974` 🚀	2021-08-28 22:38:06 +00:00
feature_stenography.md	Deploying to gh-pages from master @ `88fe5c16a5` 🚀	2021-11-28 00:12:20 +00:00
feature_swap_hands.md	Deploying to gh-pages from master @ `d8324e8a9c` 🚀	2021-11-29 08:25:46 +00:00
feature_tap_dance.md	Deploying to gh-pages from master @ `14f886d03b` 🚀	2022-02-06 17:38:19 +00:00
feature_terminal.md	Deploying to gh-pages from master @ `aae3b35c0f` 🚀	2020-11-10 15:02:44 +00:00
feature_thermal_printer.md	Deploying to gh-pages from master @ `aae3b35c0f` 🚀	2020-11-10 15:02:44 +00:00
feature_unicode.md	Deploying to gh-pages from master @ `1646c0f26c` 🚀	2021-05-29 21:40:23 +00:00
feature_userspace.md	Deploying to gh-pages from master @ `88fe5c16a5` 🚀	2021-11-28 00:12:20 +00:00
feature_velocikey.md	Deploying to gh-pages from master @ `88fe5c16a5` 🚀	2021-11-28 00:12:20 +00:00
feature_wpm.md	Deploying to gh-pages from master @ `88fe5c16a5` 🚀	2021-11-28 00:12:20 +00:00
flashing.md	Deploying to gh-pages from master @ `755731f0ba` 🚀	2021-12-08 04:38:06 +00:00
flashing_bootloadhid.md	Deploying to gh-pages from master @ `88fe5c16a5` 🚀	2021-11-28 00:12:20 +00:00
fuse.txt	Deploying to gh-pages from master @ `1b7b72c0e9` 🚀	2020-12-27 17:38:14 +00:00
getting_started_docker.md	Deploying to gh-pages from master @ `88fe5c16a5` 🚀	2021-11-28 00:12:20 +00:00
getting_started_github.md	Deploying to gh-pages from master @ `88fe5c16a5` 🚀	2021-11-28 00:12:20 +00:00
getting_started_introduction.md	Deploying to gh-pages from master @ `aae3b35c0f` 🚀	2020-11-10 15:02:44 +00:00
getting_started_make_guide.md	Deploying to gh-pages from master @ `88fe5c16a5` 🚀	2021-11-28 00:12:20 +00:00
getting_started_vagrant.md	Deploying to gh-pages from master @ `88fe5c16a5` 🚀	2021-11-28 00:12:20 +00:00
hand_wire.md	Deploying to gh-pages from master @ `6fd9b2feba` 🚀	2021-07-30 05:57:53 +00:00
hardware_avr.md	Deploying to gh-pages from master @ `14f886d03b` 🚀	2022-02-06 17:38:19 +00:00
hardware_drivers.md	Deploying to gh-pages from master @ `88fe5c16a5` 🚀	2021-11-28 00:12:20 +00:00
hardware_keyboard_guidelines.md	Deploying to gh-pages from master @ `87199eb2f5` 🚀	2022-02-06 17:39:30 +00:00
how_a_matrix_works.md	Deploying to gh-pages from master @ `92a787ca4c` 🚀	2021-01-30 11:02:49 +00:00
how_keyboards_work.md	Deploying to gh-pages from master @ `88fe5c16a5` 🚀	2021-11-28 00:12:20 +00:00
i2c_driver.md	Deploying to gh-pages from master @ `88fe5c16a5` 🚀	2021-11-28 00:12:20 +00:00
index.html	Deploying to gh-pages from master @ `1c1e6fa47d` 🚀	2022-01-05 02:13:02 +00:00
internals_SERIAL_USB.md	Deploying to gh-pages from master @ `d3584be431` 🚀	2022-02-21 17:10:03 +00:00
internals_defines.md	Deploying to gh-pages from master @ `d3584be431` 🚀	2022-02-21 17:10:03 +00:00
internals_gpio_control.md	Deploying to gh-pages from master @ `88fe5c16a5` 🚀	2021-11-28 00:12:20 +00:00
internals_input_callback_reg.md	Deploying to gh-pages from master @ `d3584be431` 🚀	2022-02-21 17:10:03 +00:00
internals_midi_device.md	Deploying to gh-pages from master @ `d3584be431` 🚀	2022-02-21 17:10:03 +00:00
internals_midi_device_setup_process.md	Deploying to gh-pages from master @ `d3584be431` 🚀	2022-02-21 17:10:03 +00:00
internals_midi_util.md	Deploying to gh-pages from master @ `d3584be431` 🚀	2022-02-21 17:10:03 +00:00
internals_send_functions.md	Deploying to gh-pages from master @ `d3584be431` 🚀	2022-02-21 17:10:03 +00:00
internals_sysex_tools.md	Deploying to gh-pages from master @ `d3584be431` 🚀	2022-02-21 17:10:03 +00:00
isp_flashing_guide.md	Deploying to gh-pages from master @ `03b1d9ef1f` 🚀	2022-01-30 19:07:58 +00:00
keycodes.md	Deploying to gh-pages from master @ `9e92d8a905` 🚀	2022-01-14 14:49:27 +00:00
keycodes_basic.md	Deploying to gh-pages from master @ `88fe5c16a5` 🚀	2021-11-28 00:12:20 +00:00
keycodes_magic.md	Deploying to gh-pages from master @ `f061ca4974` 🚀	2021-08-28 22:38:06 +00:00
keycodes_us_ansi_shifted.md	Deploying to gh-pages from master @ `14f886d03b` 🚀	2022-02-06 17:38:19 +00:00
keymap.md	Deploying to gh-pages from master @ `88fe5c16a5` 🚀	2021-11-28 00:12:20 +00:00
mod_tap.md	Deploying to gh-pages from master @ `14f886d03b` 🚀	2022-02-06 17:38:19 +00:00
newbs.md	Deploying to gh-pages from master @ `92a787ca4c` 🚀	2021-01-30 11:02:49 +00:00
newbs_building_firmware.md	Deploying to gh-pages from master @ `d3584be431` 🚀	2022-02-21 17:10:03 +00:00
newbs_building_firmware_configurator.md	Deploying to gh-pages from master @ `4e8166750b` 🚀	2021-01-20 18:48:18 +00:00
newbs_flashing.md	Deploying to gh-pages from master @ `069ef7eb9e` 🚀	2022-01-11 00:55:53 +00:00
newbs_getting_started.md	Deploying to gh-pages from master @ `362a65510a` 🚀	2022-01-13 02:30:56 +00:00
newbs_git_best_practices.md	Deploying to gh-pages from master @ `aae3b35c0f` 🚀	2020-11-10 15:02:44 +00:00
newbs_git_resolving_merge_conflicts.md	Deploying to gh-pages from master @ `aae3b35c0f` 🚀	2020-11-10 15:02:44 +00:00
newbs_git_resynchronize_a_branch.md	Deploying to gh-pages from master @ `88fe5c16a5` 🚀	2021-11-28 00:12:20 +00:00
newbs_git_using_your_master_branch.md	Deploying to gh-pages from master @ `aae3b35c0f` 🚀	2020-11-10 15:02:44 +00:00
newbs_learn_more_resources.md	Deploying to gh-pages from master @ `8901c9eca1` 🚀	2022-01-21 15:50:10 +00:00
newbs_testing_debugging.md	Deploying to gh-pages from master @ `4e8166750b` 🚀	2021-01-20 18:48:18 +00:00
one_shot_keys.md	Deploying to gh-pages from master @ `fcce9f2a4f` 🚀	2021-07-28 11:02:36 +00:00
other_eclipse.md	Deploying to gh-pages from master @ `14f886d03b` 🚀	2022-02-06 17:38:19 +00:00
other_vscode.md	Deploying to gh-pages from master @ `14f886d03b` 🚀	2022-02-06 17:38:19 +00:00
platformdev_chibios_earlyinit.md	Deploying to gh-pages from master @ `1b7b72c0e9` 🚀	2020-12-27 17:38:14 +00:00
platformdev_selecting_arm_mcu.md	Deploying to gh-pages from master @ `aae3b35c0f` 🚀	2020-11-10 15:02:44 +00:00
power.txt	Deploying to gh-pages from master @ `aae3b35c0f` 🚀	2020-11-10 15:02:44 +00:00
pr_checklist.md	Deploying to gh-pages from master @ `04020da48c` 🚀	2022-02-09 05:14:22 +00:00
proton_c_conversion.md	Deploying to gh-pages from master @ `1a5f6b54af` 🚀	2021-02-27 20:29:41 +00:00
qmk.css	Deploying to gh-pages from master @ `aae3b35c0f` 🚀	2020-11-10 15:02:44 +00:00
qmk_custom_dark.css	Deploying to gh-pages from master @ `4e8166750b` 🚀	2021-01-20 18:48:18 +00:00
qmk_custom_light.css	Deploying to gh-pages from master @ `4e8166750b` 🚀	2021-01-20 18:48:18 +00:00
quantum_keycodes.md	Deploying to gh-pages from master @ `aae3b35c0f` 🚀	2020-11-10 15:02:44 +00:00
redirects.json	Deploying to gh-pages from master @ `aae3b35c0f` 🚀	2020-11-10 15:02:44 +00:00
ref_functions.md	Deploying to gh-pages from master @ `435fa2c391` 🚀	2021-12-24 20:11:45 +00:00
reference_configurator_support.md	Deploying to gh-pages from master @ `88fe5c16a5` 🚀	2021-11-28 00:12:20 +00:00
reference_glossary.md	Deploying to gh-pages from master @ `014aa0661e` 🚀	2021-09-04 14:03:37 +00:00
reference_info_json.md	Deploying to gh-pages from master @ `b7a346600c` 🚀	2021-10-15 01:47:20 +00:00
reference_keymap_extras.md	Deploying to gh-pages from master @ `fce12f0075` 🚀	2021-08-14 14:19:56 +00:00
serial_driver.md	Deploying to gh-pages from master @ `f061ca4974` 🚀	2021-08-28 22:38:06 +00:00
spi_driver.md	Deploying to gh-pages from master @ `1a5f6b54af` 🚀	2021-02-27 20:29:41 +00:00
squeezing_avr.md	Deploying to gh-pages from master @ `1fffcbc298` 🚀	2022-02-04 18:59:12 +00:00
support.md	Deploying to gh-pages from master @ `aae3b35c0f` 🚀	2020-11-10 15:02:44 +00:00
sw.js	Deploying to gh-pages from master @ `aae3b35c0f` 🚀	2020-11-10 15:02:44 +00:00
syllabus.md	Deploying to gh-pages from master @ `88fe5c16a5` 🚀	2021-11-28 00:12:20 +00:00
tap_hold.md	Deploying to gh-pages from master @ `88fe5c16a5` 🚀	2021-11-28 00:12:20 +00:00
translating.md	Deploying to gh-pages from master @ `aae3b35c0f` 🚀	2020-11-10 15:02:44 +00:00
uart_driver.md	Deploying to gh-pages from master @ `88fe5c16a5` 🚀	2021-11-28 00:12:20 +00:00
understanding_qmk.md	Deploying to gh-pages from master @ `c2e0b283c3` 🚀	2021-11-30 19:26:12 +00:00
unit_testing.md	Deploying to gh-pages from master @ `88fe5c16a5` 🚀	2021-11-28 00:12:20 +00:00
usb_nkro.txt	Deploying to gh-pages from master @ `aae3b35c0f` 🚀	2020-11-10 15:02:44 +00:00
ws2812_driver.md	Deploying to gh-pages from master @ `88fe5c16a5` 🚀	2021-11-28 00:12:20 +00: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

?> 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