keyboard/qmk/docs
2020-12-25 15:21:40 -05:00
..
ChangeLog Update qmk sources 2020-12-25 15:21:40 -05:00
de Update qmk sources 2020-12-25 15:21:40 -05:00
es Update qmk sources 2020-12-25 15:21:40 -05:00
fr-fr Update qmk sources 2020-12-25 15:21:40 -05:00
gitbook/images Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
he-il Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
ja Update qmk sources 2020-12-25 15:21:40 -05:00
ko-kr Update qmk sources 2020-12-25 15:21:40 -05:00
pt-br Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
ru-ru Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
zh-cn Update qmk sources 2020-12-25 15:21:40 -05:00
.nojekyll Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
_langs.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
_summary.md Update qmk sources 2020-12-25 15:21:40 -05:00
adc_driver.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
api_development_environment.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
api_development_overview.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
api_docs.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
api_overview.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
arm_debugging.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
breaking_changes.md Update qmk sources 2020-12-25 15:21:40 -05:00
breaking_changes_instructions.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
cli.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
cli_commands.md Update qmk sources 2020-12-25 15:21:40 -05:00
cli_configuration.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
cli_development.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
CNAME Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
coding_conventions_c.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
coding_conventions_python.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
compatible_microcontrollers.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
config_options.md Update qmk sources 2020-12-25 15:21:40 -05:00
configurator_default_keymaps.md Update to latest qmk sources 2020-10-29 17:04:34 -04:00
configurator_step_by_step.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
configurator_troubleshooting.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
contributing.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
custom_matrix.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
custom_quantum_functions.md Update qmk sources 2020-12-25 15:21:40 -05:00
documentation_best_practices.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
documentation_templates.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
driver_installation_zadig.md Update to latest qmk sources 2020-10-29 17:04:34 -04:00
eeprom_driver.md Update qmk sources 2020-12-25 15:21:40 -05:00
faq_build.md Update to latest qmk sources 2020-10-29 17:04:34 -04:00
faq_debug.md Update to latest qmk sources 2020-10-29 17:04:34 -04:00
faq_general.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
faq_keymap.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
feature_advanced_keycodes.md Update to latest qmk sources 2020-10-29 17:04:34 -04:00
feature_audio.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
feature_auto_shift.md Update qmk sources 2020-12-25 15:21:40 -05:00
feature_backlight.md Update qmk sources 2020-12-25 15:21:40 -05:00
feature_bluetooth.md Update to latest qmk sources 2020-10-29 17:04:34 -04:00
feature_bootmagic.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
feature_combo.md Update to latest qmk sources 2020-10-29 17:04:34 -04:00
feature_command.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
feature_debounce_type.md Update to latest qmk sources 2020-10-29 17:04:34 -04:00
feature_dip_switch.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
feature_dynamic_macros.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
feature_encoders.md Update qmk sources 2020-12-25 15:21:40 -05:00
feature_grave_esc.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
feature_haptic_feedback.md Update qmk sources 2020-12-25 15:21:40 -05:00
feature_hd44780.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
feature_joystick.md Update qmk sources 2020-12-25 15:21:40 -05:00
feature_key_lock.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
feature_layers.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
feature_layouts.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
feature_leader_key.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
feature_led_indicators.md Update qmk sources 2020-12-25 15:21:40 -05:00
feature_led_matrix.md Update qmk sources 2020-12-25 15:21:40 -05:00
feature_macros.md Update qmk sources 2020-12-25 15:21:40 -05:00
feature_mouse_keys.md Update qmk sources 2020-12-25 15:21:40 -05:00
feature_oled_driver.md Update qmk sources 2020-12-25 15:21:40 -05:00
feature_pointing_device.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
feature_ps2_mouse.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
feature_rawhid.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
feature_rgb_matrix.md Update qmk sources 2020-12-25 15:21:40 -05:00
feature_rgblight.md Update qmk sources 2020-12-25 15:21:40 -05:00
feature_sequencer.md Update qmk sources 2020-12-25 15:21:40 -05:00
feature_space_cadet.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
feature_split_keyboard.md Update qmk sources 2020-12-25 15:21:40 -05:00
feature_stenography.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
feature_swap_hands.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
feature_tap_dance.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
feature_terminal.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
feature_thermal_printer.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
feature_unicode.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
feature_userspace.md Update qmk sources 2020-12-25 15:21:40 -05:00
feature_velocikey.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
feature_wpm.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
flashing.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
flashing_bootloadhid.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
fuse.txt Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
getting_started_docker.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
getting_started_github.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
getting_started_introduction.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
getting_started_make_guide.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
getting_started_vagrant.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
hand_wire.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
hardware_avr.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
hardware_drivers.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
hardware_keyboard_guidelines.md Update qmk sources 2020-12-25 15:21:40 -05:00
how_a_matrix_works.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
how_keyboards_work.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
i2c_driver.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
index.html Update qmk sources 2020-12-25 15:21:40 -05:00
internals_defines.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
internals_gpio_control.md Update qmk sources 2020-12-25 15:21:40 -05:00
internals_input_callback_reg.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
internals_midi_device.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
internals_midi_device_setup_process.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
internals_midi_util.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
internals_send_functions.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
internals_sysex_tools.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
isp_flashing_guide.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
keycodes.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
keycodes_basic.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
keycodes_us_ansi_shifted.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
keymap.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
mod_tap.md Update to latest qmk sources 2020-10-29 17:04:34 -04:00
newbs.md Update qmk sources 2020-12-25 15:21:40 -05:00
newbs_building_firmware.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
newbs_building_firmware_configurator.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
newbs_flashing.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
newbs_getting_started.md Update qmk sources 2020-12-25 15:21:40 -05:00
newbs_git_best_practices.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
newbs_git_resolving_merge_conflicts.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
newbs_git_resynchronize_a_branch.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
newbs_git_using_your_master_branch.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
newbs_learn_more_resources.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
newbs_testing_debugging.md Update qmk sources 2020-12-25 15:21:40 -05:00
one_shot_keys.md Update qmk sources 2020-12-25 15:21:40 -05:00
other_eclipse.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
other_vscode.md Update to latest qmk sources 2020-10-29 17:04:34 -04:00
platformdev_chibios_earlyinit.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
platformdev_selecting_arm_mcu.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
power.txt Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
pr_checklist.md Update qmk sources 2020-12-25 15:21:40 -05:00
proton_c_conversion.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
qmk.css Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
qmk_custom_dark.css Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
qmk_custom_light.css Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
quantum_keycodes.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
README.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
redirects.json Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
ref_functions.md Update to latest qmk sources 2020-10-29 17:04:34 -04:00
reference_configurator_support.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
reference_glossary.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
reference_info_json.md Update to latest qmk sources 2020-10-29 17:04:34 -04:00
reference_keymap_extras.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
serial_driver.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
spi_driver.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
support.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
sw.js Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
syllabus.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
tap_hold.md Update qmk sources 2020-12-25 15:21:40 -05:00
translating.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
understanding_qmk.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
unit_testing.md Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
usb_nkro.txt Add back qmk firmware that's been updated for kemonine setups 2020-09-24 23:24:14 -04:00
ws2812_driver.md Update qmk sources 2020-12-25 15:21:40 -05:00

Quantum Mechanical Keyboard Firmware

Current Version Build Status Discord Docs Status GitHub contributors GitHub forks

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:

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.