My local repo of qmk firmware.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
zvecr 0cf7908370 Deploying to gh-pages from master @ 94755308e0 🚀 3 years ago
ChangeLog Deploying to gh-pages from master @ e793128991 🚀 3 years ago
gitbook/images Deploying to gh-pages from master @ aae3b35c0f 🚀 5 years ago
ja Deploying to gh-pages from master @ 0880850b15 🚀 3 years ago
zh-cn Deploying to gh-pages from master @ 83ce70c821 🚀 3 years ago
.nojekyll Deploying to gh-pages from master @ aae3b35c0f 🚀 5 years ago
CNAME Deploying to gh-pages from master @ aae3b35c0f 🚀 5 years ago
README.md Deploying to gh-pages from master @ 4e8166750b 🚀 4 years ago
_langs.md Deploying to gh-pages from master @ 1c1e6fa47d 🚀 3 years ago
_summary.md Deploying to gh-pages from master @ e793128991 🚀 3 years ago
adc_driver.md Deploying to gh-pages from master @ 1646c0f26c 🚀 4 years ago
api_development_environment.md Deploying to gh-pages from master @ aae3b35c0f 🚀 5 years ago
api_development_overview.md Deploying to gh-pages from master @ aae3b35c0f 🚀 5 years ago
api_docs.md Deploying to gh-pages from master @ 14f886d03b 🚀 3 years ago
api_overview.md Deploying to gh-pages from master @ 92a787ca4c 🚀 4 years ago
arm_debugging.md Deploying to gh-pages from master @ aae3b35c0f 🚀 5 years ago
audio_driver.md Deploying to gh-pages from master @ 88fe5c16a5 🚀 4 years ago
breaking_changes.md Deploying to gh-pages from master @ e793128991 🚀 3 years ago
breaking_changes_history.md Deploying to gh-pages from master @ e793128991 🚀 3 years ago
breaking_changes_instructions.md Deploying to gh-pages from master @ aae3b35c0f 🚀 5 years ago
chibios_upgrade_instructions.md Deploying to gh-pages from master @ 88fe5c16a5 🚀 4 years ago
cli.md Deploying to gh-pages from master @ aae3b35c0f 🚀 5 years ago
cli_commands.md Deploying to gh-pages from master @ efc9c525b1 🚀 3 years ago
cli_configuration.md Deploying to gh-pages from master @ aae3b35c0f 🚀 5 years ago
cli_development.md Deploying to gh-pages from master @ da6d6ce2e1 🚀 3 years ago
cli_tab_complete.md Deploying to gh-pages from master @ 0002acd4a3 🚀 4 years ago
coding_conventions_c.md Deploying to gh-pages from master @ 92a787ca4c 🚀 4 years ago
coding_conventions_python.md Deploying to gh-pages from master @ fefd7fdc51 🚀 4 years ago
compatible_microcontrollers.md Deploying to gh-pages from master @ e793128991 🚀 3 years ago
config_options.md Deploying to gh-pages from master @ e793128991 🚀 3 years ago
configurator_architecture.md Deploying to gh-pages from master @ 9a0118c603 🚀 4 years ago
configurator_default_keymaps.md Deploying to gh-pages from master @ 88fe5c16a5 🚀 4 years ago
configurator_diagram.drawio Deploying to gh-pages from master @ 9a0118c603 🚀 4 years ago
configurator_diagram.svg Deploying to gh-pages from master @ 9a0118c603 🚀 4 years ago
configurator_step_by_step.md Deploying to gh-pages from master @ f6a7f4d4ac 🚀 3 years ago
configurator_troubleshooting.md Deploying to gh-pages from master @ aae3b35c0f 🚀 5 years ago
contributing.md Deploying to gh-pages from master @ f6a7f4d4ac 🚀 3 years ago
custom_matrix.md Deploying to gh-pages from master @ 88fe5c16a5 🚀 4 years ago
custom_quantum_functions.md Deploying to gh-pages from master @ 3403f5813c 🚀 3 years ago
data_driven_config.md Deploying to gh-pages from master @ 87199eb2f5 🚀 3 years ago
documentation_best_practices.md Deploying to gh-pages from master @ aae3b35c0f 🚀 5 years ago
documentation_templates.md Deploying to gh-pages from master @ 92a787ca4c 🚀 4 years ago
driver_installation_zadig.md Deploying to gh-pages from master @ 88fe5c16a5 🚀 4 years ago
easy_maker.md Deploying to gh-pages from master @ f6a7f4d4ac 🚀 3 years ago
eeprom_driver.md Deploying to gh-pages from master @ f061ca4974 🚀 4 years ago
faq_build.md Deploying to gh-pages from master @ 92a787ca4c 🚀 4 years ago
faq_debug.md Deploying to gh-pages from master @ 3f1f60cbf9 🚀 3 years ago
faq_general.md Deploying to gh-pages from master @ d6701b3ac7 🚀 4 years ago
faq_keymap.md Deploying to gh-pages from master @ 88fe5c16a5 🚀 4 years ago
faq_misc.md Deploying to gh-pages from master @ 88fe5c16a5 🚀 4 years ago
feature_advanced_keycodes.md Deploying to gh-pages from master @ 92dd1b977b 🚀 4 years ago
feature_audio.md Deploying to gh-pages from master @ f061ca4974 🚀 4 years ago
feature_auto_shift.md Deploying to gh-pages from master @ 88fe5c16a5 🚀 4 years ago
feature_backlight.md Deploying to gh-pages from master @ 88fe5c16a5 🚀 4 years ago
feature_bluetooth.md Deploying to gh-pages from master @ e793128991 🚀 3 years ago
feature_bootmagic.md Deploying to gh-pages from master @ 9aaf4a5a9b 🚀 3 years ago
feature_combo.md Deploying to gh-pages from master @ e793128991 🚀 3 years ago
feature_command.md Deploying to gh-pages from master @ f061ca4974 🚀 4 years ago
feature_debounce_type.md Deploying to gh-pages from master @ e793128991 🚀 3 years ago
feature_digitizer.md Deploying to gh-pages from master @ 88fe5c16a5 🚀 4 years ago
feature_dip_switch.md Deploying to gh-pages from master @ f061ca4974 🚀 4 years ago
feature_dynamic_macros.md Deploying to gh-pages from master @ aae3b35c0f 🚀 5 years ago
feature_encoders.md Deploying to gh-pages from master @ f662939037 🚀 3 years ago
feature_grave_esc.md Deploying to gh-pages from master @ e793128991 🚀 3 years ago
feature_haptic_feedback.md Deploying to gh-pages from master @ e793128991 🚀 3 years ago
feature_hd44780.md Deploying to gh-pages from master @ aae3b35c0f 🚀 5 years ago
feature_joystick.md Deploying to gh-pages from master @ 88fe5c16a5 🚀 4 years ago
feature_key_lock.md Deploying to gh-pages from master @ e793128991 🚀 3 years ago
feature_key_overrides.md Deploying to gh-pages from master @ 88fe5c16a5 🚀 4 years ago
feature_layers.md Deploying to gh-pages from master @ 88fe5c16a5 🚀 4 years ago
feature_layouts.md Deploying to gh-pages from master @ 88fe5c16a5 🚀 4 years ago
feature_leader_key.md Deploying to gh-pages from master @ b1f8622513 🚀 3 years ago
feature_led_indicators.md Deploying to gh-pages from master @ a5a4597311 🚀 3 years ago
feature_led_matrix.md Deploying to gh-pages from master @ e793128991 🚀 3 years ago
feature_macros.md Deploying to gh-pages from master @ f52cc210b8 🚀 3 years ago
feature_midi.md Deploying to gh-pages from master @ 88fe5c16a5 🚀 4 years ago
feature_mouse_keys.md Deploying to gh-pages from master @ e793128991 🚀 3 years ago
feature_oled_driver.md Deploying to gh-pages from master @ 0f0e90971b 🚀 3 years ago
feature_pointing_device.md Deploying to gh-pages from master @ 86b123141b 🚀 3 years ago
feature_programmable_button.md Deploying to gh-pages from master @ 88fe5c16a5 🚀 4 years ago
feature_ps2_mouse.md Deploying to gh-pages from master @ 88fe5c16a5 🚀 4 years ago
feature_rawhid.md Deploying to gh-pages from master @ 88fe5c16a5 🚀 4 years ago
feature_rgb_matrix.md Deploying to gh-pages from master @ 29ab430f1f 🚀 3 years ago
feature_rgblight.md Deploying to gh-pages from master @ 259cf76966 🚀 3 years ago
feature_sequencer.md Deploying to gh-pages from master @ 1b7b72c0e9 🚀 4 years ago
feature_space_cadet.md Deploying to gh-pages from master @ 92a787ca4c 🚀 4 years ago
feature_split_keyboard.md Deploying to gh-pages from master @ e793128991 🚀 3 years ago
feature_st7565.md Deploying to gh-pages from master @ f061ca4974 🚀 4 years ago
feature_stenography.md Deploying to gh-pages from master @ 88fe5c16a5 🚀 4 years ago
feature_swap_hands.md Deploying to gh-pages from master @ d8324e8a9c 🚀 4 years ago
feature_tap_dance.md Deploying to gh-pages from master @ 14f886d03b 🚀 3 years ago
feature_terminal.md Deploying to gh-pages from master @ aae3b35c0f 🚀 5 years ago
feature_thermal_printer.md Deploying to gh-pages from master @ aae3b35c0f 🚀 5 years ago
feature_unicode.md Deploying to gh-pages from master @ 1646c0f26c 🚀 4 years ago
feature_userspace.md Deploying to gh-pages from master @ 88fe5c16a5 🚀 4 years ago
feature_velocikey.md Deploying to gh-pages from master @ 88fe5c16a5 🚀 4 years ago
feature_wpm.md Deploying to gh-pages from master @ e793128991 🚀 3 years ago
flash_driver.md Deploying to gh-pages from master @ e793128991 🚀 3 years ago
flashing.md Deploying to gh-pages from master @ 97d0e7cb2d 🚀 3 years ago
flashing_bootloadhid.md Deploying to gh-pages from master @ 88fe5c16a5 🚀 4 years ago
fuse.txt Deploying to gh-pages from master @ 1b7b72c0e9 🚀 4 years ago
getting_started_docker.md Deploying to gh-pages from master @ 88fe5c16a5 🚀 4 years ago
getting_started_github.md Deploying to gh-pages from master @ 88fe5c16a5 🚀 4 years ago
getting_started_introduction.md Deploying to gh-pages from master @ aae3b35c0f 🚀 5 years ago
getting_started_make_guide.md Deploying to gh-pages from master @ 88fe5c16a5 🚀 4 years ago
getting_started_vagrant.md Deploying to gh-pages from master @ 88fe5c16a5 🚀 4 years ago
hand_wire.md Deploying to gh-pages from master @ 6fd9b2feba 🚀 4 years ago
hardware_drivers.md Deploying to gh-pages from master @ 88fe5c16a5 🚀 4 years ago
hardware_keyboard_guidelines.md Deploying to gh-pages from master @ 87199eb2f5 🚀 3 years ago
how_a_matrix_works.md Deploying to gh-pages from master @ 92a787ca4c 🚀 4 years ago
how_keyboards_work.md Deploying to gh-pages from master @ 88fe5c16a5 🚀 4 years ago
i2c_driver.md Deploying to gh-pages from master @ 81be7bb7b5 🚀 3 years ago
index.html Deploying to gh-pages from master @ 94755308e0 🚀 3 years ago
internals_SERIAL_USB.md Deploying to gh-pages from master @ d3584be431 🚀 3 years ago
internals_defines.md Deploying to gh-pages from master @ d3584be431 🚀 3 years ago
internals_gpio_control.md Deploying to gh-pages from master @ e793128991 🚀 3 years ago
internals_input_callback_reg.md Deploying to gh-pages from master @ d3584be431 🚀 3 years ago
internals_midi_device.md Deploying to gh-pages from master @ d3584be431 🚀 3 years ago
internals_midi_device_setup_process.md Deploying to gh-pages from master @ d3584be431 🚀 3 years ago
internals_midi_util.md Deploying to gh-pages from master @ d3584be431 🚀 3 years ago
internals_send_functions.md Deploying to gh-pages from master @ d3584be431 🚀 3 years ago
internals_sysex_tools.md Deploying to gh-pages from master @ d3584be431 🚀 3 years ago
isp_flashing_guide.md Deploying to gh-pages from master @ dde4120a1e 🚀 3 years ago
keycodes.md Deploying to gh-pages from master @ e793128991 🚀 3 years ago
keycodes_basic.md Deploying to gh-pages from master @ 88fe5c16a5 🚀 4 years ago
keycodes_magic.md Deploying to gh-pages from master @ e793128991 🚀 3 years ago
keycodes_us_ansi_shifted.md Deploying to gh-pages from master @ 14f886d03b 🚀 3 years ago
keymap.md Deploying to gh-pages from master @ da6d6ce2e1 🚀 3 years ago
mod_tap.md Deploying to gh-pages from master @ 14f886d03b 🚀 3 years ago
newbs.md Deploying to gh-pages from master @ 92a787ca4c 🚀 4 years ago
newbs_building_firmware.md Deploying to gh-pages from master @ d3584be431 🚀 3 years ago
newbs_building_firmware_configurator.md Deploying to gh-pages from master @ 4e8166750b 🚀 4 years ago
newbs_flashing.md Deploying to gh-pages from master @ 069ef7eb9e 🚀 3 years ago
newbs_getting_started.md Deploying to gh-pages from master @ 96b6ddf4bf 🚀 3 years ago
newbs_git_best_practices.md Deploying to gh-pages from master @ aae3b35c0f 🚀 5 years ago
newbs_git_resolving_merge_conflicts.md Deploying to gh-pages from master @ aae3b35c0f 🚀 5 years ago
newbs_git_resynchronize_a_branch.md Deploying to gh-pages from master @ 88fe5c16a5 🚀 4 years ago
newbs_git_using_your_master_branch.md Deploying to gh-pages from master @ aae3b35c0f 🚀 5 years ago
newbs_learn_more_resources.md Deploying to gh-pages from master @ 8901c9eca1 🚀 3 years ago
newbs_testing_debugging.md Deploying to gh-pages from master @ 4e8166750b 🚀 4 years ago
one_shot_keys.md Deploying to gh-pages from master @ fcce9f2a4f 🚀 4 years ago
other_eclipse.md Deploying to gh-pages from master @ 14f886d03b 🚀 3 years ago
other_vscode.md Deploying to gh-pages from master @ 14f886d03b 🚀 3 years ago
platformdev_chibios_earlyinit.md Deploying to gh-pages from master @ e793128991 🚀 3 years ago
platformdev_selecting_arm_mcu.md Deploying to gh-pages from master @ aae3b35c0f 🚀 5 years ago
porting_your_keyboard_to_qmk.md Deploying to gh-pages from master @ e793128991 🚀 3 years ago
power.txt Deploying to gh-pages from master @ aae3b35c0f 🚀 5 years ago
pr_checklist.md Deploying to gh-pages from master @ 61ba8efa3e 🚀 3 years ago
proton_c_conversion.md Deploying to gh-pages from master @ 1a5f6b54af 🚀 4 years ago
qmk.css Deploying to gh-pages from master @ aae3b35c0f 🚀 5 years ago
qmk_custom_dark.css Deploying to gh-pages from master @ 4e8166750b 🚀 4 years ago
qmk_custom_light.css Deploying to gh-pages from master @ 4e8166750b 🚀 4 years ago
quantum_keycodes.md Deploying to gh-pages from master @ e793128991 🚀 3 years ago
redirects.json Deploying to gh-pages from master @ aae3b35c0f 🚀 5 years ago
ref_functions.md Deploying to gh-pages from master @ 3502bbbd16 🚀 3 years ago
reference_configurator_support.md Deploying to gh-pages from master @ 88fe5c16a5 🚀 4 years ago
reference_glossary.md Deploying to gh-pages from master @ 014aa0661e 🚀 4 years ago
reference_info_json.md Deploying to gh-pages from master @ 8014fb14b6 🚀 3 years ago
reference_keymap_extras.md Deploying to gh-pages from master @ e99d6d582c 🚀 3 years ago
serial_driver.md Deploying to gh-pages from master @ f061ca4974 🚀 4 years ago
spi_driver.md Deploying to gh-pages from master @ 1a5f6b54af 🚀 4 years ago
squeezing_avr.md Deploying to gh-pages from master @ e01307f265 🚀 3 years ago
support.md Deploying to gh-pages from master @ aae3b35c0f 🚀 5 years ago
sw.js Deploying to gh-pages from master @ aae3b35c0f 🚀 5 years ago
syllabus.md Deploying to gh-pages from master @ 88fe5c16a5 🚀 4 years ago
tap_hold.md Deploying to gh-pages from master @ 6c40b6856b 🚀 3 years ago
translating.md Deploying to gh-pages from master @ aae3b35c0f 🚀 5 years ago
uart_driver.md Deploying to gh-pages from master @ 88fe5c16a5 🚀 4 years ago
understanding_qmk.md Deploying to gh-pages from master @ da6d6ce2e1 🚀 3 years ago
unit_testing.md Deploying to gh-pages from master @ 88fe5c16a5 🚀 4 years ago
usb_nkro.txt Deploying to gh-pages from master @ aae3b35c0f 🚀 5 years ago
ws2812_driver.md Deploying to gh-pages from master @ 88fe5c16a5 🚀 4 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.