History

s-show b1a8fafa62 [Docs] Japanese translation of docs/keycodes.md (#10192 ) * copy 'keycodes.md'. * Translated 'keycodes.md'. * Fixed typo. * Fixed typo. * Apply suggestions from code review Co-authored-by: shela <shelaf@users.noreply.github.com> Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * update based on comment. * update based on comment. * Update docs/ja/keycodes.md * update based on comment. Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * update based on comment. Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * update based on comment. Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * Update docs/ja/keycodes.md Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * update based on comment. Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> Co-authored-by: shela <shelaf@users.noreply.github.com> Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com>		2021-03-05 00:20:01 +09:00
..
ChangeLog	2021 February 27 Breaking Changes Changelog (#11975 )	2021-02-27 12:10:23 -08:00
de	…
es	…
fr-fr	…
gitbook/images	…
he-il	…
ja	[Docs] Japanese translation of docs/keycodes.md (#10192 )	2021-03-05 00:20:01 +09:00
ko-kr	…
pt-br	…
ru-ru	…
zh-cn	…
.nojekyll	…
CNAME	…
README.md	…
_langs.md	…
_summary.md	2021 February 27 Breaking Changes Changelog (#11975 )	2021-02-27 12:10:23 -08:00
adc_driver.md	…
api_development_environment.md	…
api_development_overview.md	…
api_docs.md	…
api_overview.md	…
arm_debugging.md	…
audio_driver.md	Audio system overhaul (#11820 )	2021-02-15 09:40:38 +11:00
breaking_changes.md	2021 February 27 Breaking Changes Changelog (#11975 )	2021-02-27 12:10:23 -08:00
breaking_changes_history.md	2021 February 27 Breaking Changes Changelog (#11975 )	2021-02-27 12:10:23 -08:00
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	Add STM32G431 and STM32G474 board definitions. (#11793 )	2021-02-06 11:27:46 +11:00
config_options.md	Audio system overhaul (#11820 )	2021-02-15 09:40:38 +11:00
configurator_default_keymaps.md	…
configurator_step_by_step.md	…
configurator_troubleshooting.md	…
contributing.md	…
custom_matrix.md	…
custom_quantum_functions.md	…
data_driven_config.md	Create a system to map between info.json and config.h/rules.mk (#11548 )	2021-01-31 12:46:00 -08:00
documentation_best_practices.md	…
documentation_templates.md	…
driver_installation_zadig.md	…
eeprom_driver.md	…
faq_build.md	…
faq_debug.md	Documentation changes SPLIT_USB_DETECT and hid_listen udev rules (#11665 )	2021-03-03 13:31:41 -08:00
faq_general.md	…
faq_keymap.md	…
faq_misc.md	…
feature_advanced_keycodes.md	[Docs] New section to modifier docs: Checking Modifier State (#10550 )	2021-02-28 16:42:17 +11:00
feature_audio.md	Audio system overhaul (#11820 )	2021-02-15 09:40:38 +11:00
feature_auto_shift.md	…
feature_backlight.md	…
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	…
feature_grave_esc.md	…
feature_haptic_feedback.md	[Docs] Update feature_haptic_feedback.md (#11859 )	2021-02-11 10:53:55 -08:00
feature_hd44780.md	…
feature_joystick.md	…
feature_key_lock.md	…
feature_layers.md	…
feature_layouts.md	…
feature_leader_key.md	[Docs] Small spelling mistake fix in leader keys (#12087 )	2021-03-02 18:59:03 -08:00
feature_led_indicators.md	…
feature_led_matrix.md	LED Matrix: rename `LED_DRIVER_LED_COUNT` to `DRIVER_LED_TOTAL` (#11858 )	2021-02-15 11:55:13 +11:00
feature_macros.md	[Docs] New section to modifier docs: Checking Modifier State (#10550 )	2021-02-28 16:42:17 +11:00
feature_mouse_keys.md	…
feature_oled_driver.md	…
feature_pointing_device.md	Merge remote-tracking branch 'origin/master' into develop	2021-02-04 01:25:39 +00:00
feature_ps2_mouse.md	…
feature_rawhid.md	…
feature_rgb_matrix.md	Merge remote-tracking branch 'origin/master' into develop	2021-01-30 11:01:46 +00:00
feature_rgblight.md	RGBLight: Allow configurable default settings (#11912 )	2021-02-16 10:51:28 -05:00
feature_sequencer.md	…
feature_space_cadet.md	…
feature_split_keyboard.md	Documentation changes SPLIT_USB_DETECT and hid_listen udev rules (#11665 )	2021-03-03 13:31:41 -08:00
feature_stenography.md	…
feature_swap_hands.md	…
feature_tap_dance.md	…
feature_terminal.md	…
feature_thermal_printer.md	…
feature_unicode.md	Add suggestion for indirect unicode input on Linux (#10854 )	2021-02-28 15:53:40 +11:00
feature_userspace.md	…
feature_velocikey.md	…
feature_wpm.md	…
flashing.md	…
flashing_bootloadhid.md	…
fuse.txt	…
getting_started_docker.md	Add support for using podman to util/docker_build.sh (#10819 )	2021-02-28 15:59:42 +11:00
getting_started_github.md	…
getting_started_introduction.md	…
getting_started_make_guide.md	Remove FAUXCLICKY feature (deprecated) (#11829 )	2021-02-09 09:49:05 -08:00
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	Rework I2C driver docs (#11658 )	2021-02-08 07:45:59 +11:00
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	[Docs] Update isp_flashing_guide.md (#11777 )	2021-02-07 10:48:34 -08:00
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	…
pr_checklist.md	…
proton_c_conversion.md	…
qmk.css	…
qmk_custom_dark.css	…
qmk_custom_light.css	…
quantum_keycodes.md	…
redirects.json	…
ref_functions.md	[Docs] Add EEP_RST keycode to "Wiping the EEPROM" section (#11830 )	2021-02-12 15:56:36 -08:00
reference_configurator_support.md	…
reference_glossary.md	…
reference_info_json.md	Merge remote-tracking branch 'origin/master' into develop	2021-01-30 11:01:46 +00:00
reference_keymap_extras.md	…
serial_driver.md	…
spi_driver.md	Merge remote-tracking branch 'upstream/master' into develop	2021-02-08 07:57:09 +11:00
support.md	…
sw.js	…
syllabus.md	…
tap_hold.md	Update IGNORE_MOD_TAP_INTERRUPT (#11452 )	2021-02-15 21:52:57 -05:00
translating.md	…
uart_driver.md	…
understanding_qmk.md	Split transport mirror (#11046 )	2021-02-16 11:30:33 +11:00
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

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