qmk-firmware/docs
James Young 3c98854044 update flashing.md
- minor typo on intro paragraph (the -> them)
- remove note about :check-size target (`make` task now does this automatically)
- heading level for Caterina commands section
- typo regarding Halfkay (come -> comes)
2020-03-05 16:00:10 -08:00
..
ChangeLog 2020 February 29 Breaking Changes Update (#8064) 2020-02-29 11:59:30 -08:00
de Rework the newbs guide around the qmk cli 2020-03-05 16:00:10 -08:00
es Rework the newbs guide around the qmk cli 2020-03-05 16:00:10 -08:00
fr-fr Rework the newbs guide around the qmk cli 2020-03-05 16:00:10 -08:00
gitbook/images
he-il Rework the newbs guide around the qmk cli 2020-03-05 16:00:10 -08:00
ja Rework the newbs guide around the qmk cli 2020-03-05 16:00:10 -08:00
pt-br Rework the newbs guide around the qmk cli 2020-03-05 16:00:10 -08:00
ru-ru Rework the newbs guide around the qmk cli 2020-03-05 16:00:10 -08:00
zh-cn Rework the newbs guide around the qmk cli 2020-03-05 16:00:10 -08:00
_langs.md
_summary.md Rework the newbs guide around the qmk cli 2020-03-05 16:00:10 -08:00
.nojekyll
adc_driver.md
arm_debugging.md
breaking_changes_instructions.md
breaking_changes.md Fix the Breaking Changes doc again 2020-02-29 20:46:48 -08:00
cli_configuration.md
cli_development.md
cli.md remove some unnecessary external links 2020-03-05 16:00:10 -08:00
CNAME
coding_conventions_c.md
coding_conventions_python.md
compatible_microcontrollers.md
config_options.md New feature: PERMISSIVE_HOLD_PER_KEY (#7994) 2020-02-25 13:25:52 -05:00
contributing.md
custom_matrix.md
custom_quantum_functions.md
documentation_best_practices.md
documentation_templates.md
driver_installation_zadig.md
eeprom_driver.md
faq_build.md
faq_debug.md
faq_general.md Rework the newbs guide around the qmk cli 2020-03-05 16:00:10 -08:00
faq_keymap.md
feature_advanced_keycodes.md New feature: PERMISSIVE_HOLD_PER_KEY (#7994) 2020-02-25 13:25:52 -05:00
feature_audio.md
feature_auto_shift.md
feature_backlight.md 2020 February 29 Breaking Changes Update (#8064) 2020-02-29 11:59:30 -08:00
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 2020 February 29 Breaking Changes Update (#8064) 2020-02-29 11:59:30 -08:00
feature_grave_esc.md
feature_haptic_feedback.md
feature_hd44780.md
feature_key_lock.md
feature_layouts.md
feature_leader_key.md
feature_led_matrix.md
feature_macros.md Add support for delays in send_string. (#8244) 2020-02-27 20:38:19 +11:00
feature_mouse_keys.md
feature_oled_driver.md
feature_pointing_device.md
feature_ps2_mouse.md
feature_rgb_matrix.md
feature_rgblight.md
feature_space_cadet.md
feature_split_keyboard.md
feature_stenography.md
feature_swap_hands.md
feature_tap_dance.md
feature_terminal.md
feature_thermal_printer.md
feature_unicode.md send_unicode_string(): Add support for code points > 0xFFFF (#8236) 2020-02-25 12:54:51 +11:00
feature_userspace.md
feature_velocikey.md
flashing_bootloadhid.md
flashing.md update flashing.md 2020-03-05 16:00:10 -08:00
fuse.txt
getting_started_getting_help.md Rework the newbs guide around the qmk cli 2020-03-05 16:00:10 -08:00
getting_started_github.md
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_keyboards_work.md
i2c_driver.md
index.html Add dark mode support 2020-03-05 16:00:10 -08:00
internals_defines.md
internals_gpio_control.md
internals_input_callback_reg.md
internals_midi_device_setup_process.md
internals_midi_device.md
internals_midi_util.md
internals_send_functions.md
internals_sysex_tools.md
isp_flashing_guide.md [Docs] Update ISP Flashing guide (#8149) 2020-03-01 22:29:26 -08:00
keycodes_basic.md
keycodes_us_ansi_shifted.md
keycodes.md remove some unnecessary external links 2020-03-05 16:00:10 -08:00
keymap.md
newbs_building_firmware_configurator.md clean up links to keycode references in newbs_building_firmware_configurator.md 2020-03-05 16:00:10 -08:00
newbs_building_firmware.md update newbs_building_firmware.md 2020-03-05 16:00:10 -08:00
newbs_flashing.md Rework the newbs guide around the qmk cli 2020-03-05 16:00:10 -08:00
newbs_getting_started.md Rework the newbs guide around the qmk cli 2020-03-05 16:00:10 -08: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 Rework the newbs guide around the qmk cli 2020-03-05 16:00:10 -08:00
newbs.md Rework the newbs guide around the qmk cli 2020-03-05 16:00:10 -08:00
other_eclipse.md
other_vscode.md
power.txt
proton_c_conversion.md
qmk.css
quantum_keycodes.md
README.md Rework the newbs guide around the qmk cli 2020-03-05 16:00:10 -08:00
redirects.json
ref_functions.md
reference_configurator_support.md
reference_glossary.md
reference_info_json.md
sidebar.css
support.md remove some unnecessary external links 2020-03-05 16:00:10 -08:00
sw.js
translating.md
understanding_qmk.md
unit_testing.md
usb_nkro.txt
ws2812_driver.md PWM DMA based RGB Underglow for STM32 (#7928) 2020-03-01 13:05:56 +11: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.