History

umi bae3e03e5f [Docs] Japanese translation of docs/coding_conventions_c.md (#9516 ) * add coding_conventions_c.md translation * update based on comment * update based on comment * update based on comment		2020-07-09 21:13:32 +09:00
..
ChangeLog	…
de	…
es	…
fr-fr	…
gitbook/images	…
he-il	…
ja	[Docs] Japanese translation of docs/coding_conventions_c.md (#9516 )	2020-07-09 21:13:32 +09:00
pt-br	…
ru-ru	…
zh-cn	…
.nojekyll	…
CNAME	…
README.md	…
_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	…
cli.md	…
cli_commands.md	…
cli_configuration.md	…
cli_development.md	…
coding_conventions_c.md	…
coding_conventions_python.md	…
compatible_microcontrollers.md	…
config_options.md	add SPLIT_HAND_MATRIX_GRID support (#8685 )	2020-07-04 15:04:47 +01:00
configurator_step_by_step.md	…
configurator_troubleshooting.md	…
contributing.md	…
custom_matrix.md	…
custom_quantum_functions.md	…
documentation_best_practices.md	[Docs] fix file path (#9540 )	2020-06-25 15:58:36 +10:00
documentation_templates.md	…
driver_installation_zadig.md	…
eeprom_driver.md	…
faq_build.md	Docs: update ModemManager recommendation (#9328 )	2020-07-07 19:22:38 +01:00
faq_debug.md	…
faq_general.md	…
faq_keymap.md	…
feature_advanced_keycodes.md	…
feature_audio.md	…
feature_auto_shift.md	…
feature_backlight.md	Backlight docs wordsmithing (#9631 )	2020-07-03 10:05:59 +01:00
feature_bluetooth.md	…
feature_bootmagic.md	…
feature_combo.md	…
feature_command.md	…
feature_debounce_type.md	…
feature_dip_switch.md	add DIP_SWITCH_MATRIX_GRID support (#8772 )	2020-07-04 23:20:49 +09:00
feature_dynamic_macros.md	Allowing Pressing the Start Buttons Again to Stop Dynamic Macro Recording (#9446 )	2020-07-07 21:59:13 +01:00
feature_encoders.md	…
feature_grave_esc.md	…
feature_haptic_feedback.md	…
feature_hd44780.md	…
feature_key_lock.md	…
feature_layers.md	…
feature_layouts.md	…
feature_leader_key.md	…
feature_led_matrix.md	…
feature_macros.md	…
feature_mouse_keys.md	…
feature_oled_driver.md	…
feature_pointing_device.md	…
feature_ps2_mouse.md	Add movement hook to ps2_mouse (#8805 )	2020-07-02 21:54:15 +01:00
feature_rawhid.md	…
feature_rgb_matrix.md	…
feature_rgblight.md	…
feature_space_cadet.md	…
feature_split_keyboard.md	add SPLIT_HAND_MATRIX_GRID support (#8685 )	2020-07-04 15:04:47 +01:00
feature_stenography.md	…
feature_swap_hands.md	…
feature_tap_dance.md	…
feature_terminal.md	…
feature_thermal_printer.md	…
feature_unicode.md	…
feature_userspace.md	…
feature_velocikey.md	…
feature_wpm.md	…
flashing.md	…
flashing_bootloadhid.md	…
fuse.txt	…
getting_started_docker.md	…
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_a_matrix_works.md	…
how_keyboards_work.md	…
i2c_driver.md	…
index.html	…
internals_defines.md	…
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	…
keycodes_basic.md	…
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	…
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	…
one_shot_keys.md	…
other_eclipse.md	…
other_vscode.md	…
platformdev_chibios_earlyinit.md	…
platformdev_selecting_arm_mcu.md	…
power.txt	…
proton_c_conversion.md	…
qmk.css	…
qmk_custom_dark.css	…
qmk_custom_light.css	…
quantum_keycodes.md	…
redirects.json	…
ref_functions.md	…
reference_configurator_support.md	…
reference_glossary.md	fixed link to Eclipse instructions (#9647 )	2020-07-05 08:50:01 +10:00
reference_info_json.md	…
reference_keymap_extras.md	[Keymap Extra] Add French AZERTY (AFNOR - NF Z71-300) (#9644 )	2020-07-08 19:55:02 +01:00
serial_driver.md	…
spi_driver.md	…
support.md	…
sw.js	…
syllabus.md	…
tap_hold.md	Add missing bracket for Tap-Hold code sample (#9675 )	2020-07-08 13:40:13 +10:00
translating.md	…
understanding_qmk.md	…
unit_testing.md	…
usb_nkro.txt	…
ws2812_driver.md	…

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