umi 5f00df0c4c [Docs] Japanese translation of docs/reference_keymap_extras.md (#10138)		il y a 6 ans
..
ChangeLog	c56b9a1ce9 Add ChangeLog for 2020 Aug 29 Breaking Changes	il y a 6 ans
de	e4823aadec Fix capitalisation of "GitHub" (#9184)	il y a 6 ans
es	72d3270547 Remove `DESCRIPTION` (#9732)	il y a 6 ans
fr-fr	e4823aadec Fix capitalisation of "GitHub" (#9184)	il y a 6 ans
gitbook	4580d3a730 RGB improvements (#1684)	il y a 9 ans
he-il	e4823aadec Fix capitalisation of "GitHub" (#9184)	il y a 6 ans
ja	5f00df0c4c [Docs] Japanese translation of docs/reference_keymap_extras.md (#10138)	il y a 6 ans
pt-br	e4823aadec Fix capitalisation of "GitHub" (#9184)	il y a 6 ans
ru-ru	e4823aadec Fix capitalisation of "GitHub" (#9184)	il y a 6 ans
zh-cn	5bd239e1c0 Remove unnecessary break after return from documentation (#9892)	il y a 6 ans
.nojekyll	9e5676650e Use docsfy to replace gitbook	il y a 8 ans
CNAME	4d26137e2a Create CNAME	il y a 8 ans
README.md	961477c791 make sure all our redirects are in order	il y a 6 ans
_langs.md	10e8ed7430 [Docs] add README translation in portuguese (#7016)	il y a 6 ans
_summary.md	d4be07dad3 Hid joystick interface (#4226)	il y a 6 ans
adc_driver.md	8a4a0c25fd Change analogRead calls to analogReadPin (#9023)	il y a 6 ans
api_development_environment.md	99850aabca Add API documentation	il y a 6 ans
api_development_overview.md	99850aabca Add API documentation	il y a 6 ans
api_docs.md	99850aabca Add API documentation	il y a 6 ans
api_overview.md	99850aabca Add API documentation	il y a 6 ans
arm_debugging.md	52c18ef026 [Docs] fix docs (#7642)	il y a 6 ans
breaking_changes.md	000eb14d78 update "Breaking Changes" doc	il y a 6 ans
breaking_changes_instructions.md	fced377ac0 2020 May 30 Breaking Changes Update (#9215)	il y a 6 ans
cli.md	fcf150bd82 Streamline the macos install process	il y a 6 ans
cli_commands.md	751316c344 [CLI] Add a subcommand for getting information about a keyboard (#8666)	il y a 6 ans
cli_configuration.md	e4823aadec Fix capitalisation of "GitHub" (#9184)	il y a 6 ans
cli_development.md	e4823aadec Fix capitalisation of "GitHub" (#9184)	il y a 6 ans
coding_conventions_c.md	f4b67cde8a Update C coding conventions to match .clang-format config for i… (#8717)	il y a 6 ans
coding_conventions_python.md	66d94dc22a Move everything to Python 3.6 (#8835)	il y a 6 ans
compatible_microcontrollers.md	7aa4cc9603 adds support for the atmega328 (#9043)	il y a 6 ans
config_options.md	0f596881b3 Remove support for Adafruit EZ-Key (#10103)	il y a 6 ans
configurator_step_by_step.md	e4823aadec Fix capitalisation of "GitHub" (#9184)	il y a 6 ans
configurator_troubleshooting.md	d5f34c4810 Polish Configurator section	il y a 6 ans
contributing.md	54c58ea6de Add explicit id tags to externally linked headers	il y a 6 ans
custom_matrix.md	6e710426a4 Add docs for 'CUSTOM_MATRIX = lite' (#7906)	il y a 6 ans
custom_quantum_functions.md	5bd239e1c0 Remove unnecessary break after return from documentation (#9892)	il y a 6 ans
documentation_best_practices.md	995464cb9c [Docs] fix file path (#9540)	il y a 6 ans
documentation_templates.md	54c58ea6de Add explicit id tags to externally linked headers	il y a 6 ans
driver_installation_zadig.md	19b70b2737 MSYS2: Switch to bootloadHID package and bring back avrdude package (#9736)	il y a 6 ans
eeprom_driver.md	54b04d9665 Add SPI 25xx EEPROM support. (#8780)	il y a 6 ans
faq_build.md	e6bcc232ed Docs: update ModemManager recommendation (#9328)	il y a 6 ans
faq_debug.md	bc13dcd349 Remove Atmel FLIP from install scripts and documentation (#8822)	il y a 6 ans
faq_general.md	a701c15d87 Rework the newbs guide around the qmk cli	il y a 6 ans
faq_keymap.md	12e43230c6 make custom_keycode_names.md a faq entry instead	il y a 6 ans
feature_advanced_keycodes.md	370577e4ed Add OPT aliases for ALT keycodes and macros (#8714)	il y a 6 ans
feature_audio.md	d534c72a54 Added keycodes for swapping and unswapping the Control and OS keys (#6110)	il y a 7 ans
feature_auto_shift.md	568cae28ec #define AUTO_SHIFT_SETUP (#8441)	il y a 6 ans
feature_backlight.md	15b5ff1dc2 Remove f072 backlight warning (#10040)	il y a 6 ans
feature_bluetooth.md	0f596881b3 Remove support for Adafruit EZ-Key (#10103)	il y a 6 ans
feature_bootmagic.md	789e199450 Add support for Bootmagic lite when using SPLIT_HAND_PIN (#8347)	il y a 6 ans
feature_combo.md	57540af102 Change "yu" to "you" in combo docs (#6510)	il y a 7 ans
feature_command.md	a2e91ebec9 Update IS_COMMAND definitions to use MOD_MASK_SHIFT (#6348)	il y a 7 ans
feature_debounce_type.md	f7ccbfcea8 quantum/debounce: rename debouncing algorithms (#9564)	il y a 6 ans
feature_dip_switch.md	c2ca57c8f4 add DIP_SWITCH_MATRIX_GRID support (#8772)	il y a 6 ans
feature_dynamic_macros.md	cdb69da86e Fix typo in docs/feature_dynamic_macros (#10085)	il y a 6 ans
feature_encoders.md	b7da69ec85 Adding information to feature_encoders.md (#9486)	il y a 6 ans
feature_grave_esc.md	3510d8dc8d Document an annoyance with Grave Escape and macOS Terminal (#5483)	il y a 7 ans
feature_haptic_feedback.md	f275ffbdfc Minor grammar and filename fixes in docs (#7559)	il y a 6 ans
feature_hd44780.md	d846660e00 fixed typo for clear lcd screen function in hd44780 docs (#9086)	il y a 6 ans
feature_joystick.md	bdd8d2679b Allow joysticks to be used without analog pins (#10169)	il y a 6 ans
feature_key_lock.md	54c58ea6de Add explicit id tags to externally linked headers	il y a 6 ans
feature_layers.md	61b64bb82a Redefine IS_LAYER_ON/OFF() as aliases for existing layer functions (#6352)	il y a 6 ans
feature_layouts.md	40e67a3074 Add a mechanism for force building a particular community layout (#5027)	il y a 7 ans
feature_leader_key.md	294cfd8d33 Delete trailing period in documentation (#9416)	il y a 6 ans
feature_led_matrix.md	24df54b807 Add documentation for led matrix	il y a 7 ans
feature_macros.md	02781979d6 [Docs] Improve Unicode documentation (#8676)	il y a 6 ans
feature_mouse_keys.md	19006c9753 Implemented New MK_COMBINED Functionality (#9557)	il y a 6 ans
feature_oled_driver.md	fa6cf85727 Add a method to read the OLED display buffer from user space (#8777)	il y a 6 ans
feature_pointing_device.md	573d1fbb92 Include `pointing_device_send` in docs (#9185)	il y a 6 ans
feature_ps2_mouse.md	b7dc2eb9ab Add movement hook to ps2_mouse (#8805)	il y a 6 ans
feature_rawhid.md	d1df576ece Allow for overriding RAW endpoint usage page and ID. (#8834)	il y a 6 ans
feature_rgb_matrix.md	e34eca361f Noeeprom functions for rgb_matrix (#9487)	il y a 6 ans
feature_rgblight.md	4b74f985ec Tweak the Christmas animation effect to be less harsh on the eyes (#7648)	il y a 6 ans
feature_space_cadet.md	d16db69367 Added mod carry over from press to release. (#5866)	il y a 7 ans
feature_split_keyboard.md	088888937a Replace figures in docs/feature_split_keyboard.md (#10242)	il y a 6 ans
feature_stenography.md	64603ab647 fix typo (#9695)	il y a 6 ans
feature_swap_hands.md	805f5cb72b One shot support for swap hands (#8590)	il y a 6 ans
feature_tap_dance.md	9d3b26a475 Update features to use Custom Tapping Term when appropriate (#6259)	il y a 6 ans
feature_terminal.md	b23f6011c3 Remove build option firmware size impacts (#6947)	il y a 6 ans
feature_thermal_printer.md	4c675a83ba Format keycode tables	il y a 8 ans
feature_unicode.md	02781979d6 [Docs] Improve Unicode documentation (#8676)	il y a 6 ans
feature_userspace.md	2543bad250 [Docs] Fixed the hyperlink to `/users/_example/`. (#9326)	il y a 6 ans
feature_velocikey.md	c1c5922aae Velocikey: Match RGB animation speed to typing speed (#3754)	il y a 7 ans
feature_wpm.md	bfb2f8e0a8 Add Word Per Minute calculation feature (#8054)	il y a 6 ans
flashing.md	d00ac5dfb6 Add `st-flash` flash target (#9964)	il y a 6 ans
flashing_bootloadhid.md	235da6973d Install bootloadHid as part of qmk_install (#7463)	il y a 6 ans
fuse.txt	ca01d94005 convert docs to lowercase and underscores	il y a 9 ans
getting_started_docker.md	0fbcb41c85 Reintegrate previous docker docs (#9084)	il y a 6 ans
getting_started_github.md	e4823aadec Fix capitalisation of "GitHub" (#9184)	il y a 6 ans
getting_started_introduction.md	09c7304bd9 [Docs] update git command and directory name of documents (#7619)	il y a 6 ans
getting_started_make_guide.md	0f596881b3 Remove support for Adafruit EZ-Key (#10103)	il y a 6 ans
getting_started_vagrant.md	bc13dcd349 Remove Atmel FLIP from install scripts and documentation (#8822)	il y a 6 ans
hand_wire.md	961477c791 make sure all our redirects are in order	il y a 6 ans
hardware_avr.md	72d3270547 Remove `DESCRIPTION` (#9732)	il y a 6 ans
hardware_drivers.md	d13ada1162 Add customisable EEPROM driver selection (#7274)	il y a 6 ans
hardware_keyboard_guidelines.md	dc98d44582 [Docs] added the description of the reading order of the rules.mk files. (#8566)	il y a 6 ans
how_a_matrix_works.md	a95a314f78 refactor How a Matrix Works doc	il y a 6 ans
how_keyboards_work.md	d5316e9714 Update URL for `60-keyboard.hwdb` (#7185)	il y a 6 ans
i2c_driver.md	346bfb2a05 Update i2c_driver.md (#10131)	il y a 6 ans
index.html	e182a38e7c Add redirect for old getting started links (#8987)	il y a 6 ans
internals_defines.md	ae7284edb8 rename api docs to internals	il y a 8 ans
internals_gpio_control.md	d26a14c169 add 'togglePin' convenience function (#8734)	il y a 6 ans
internals_input_callback_reg.md	ae7284edb8 rename api docs to internals	il y a 8 ans
internals_midi_device.md	ae7284edb8 rename api docs to internals	il y a 8 ans
internals_midi_device_setup_process.md	ae7284edb8 rename api docs to internals	il y a 8 ans
internals_midi_util.md	ae7284edb8 rename api docs to internals	il y a 8 ans
internals_send_functions.md	ae7284edb8 rename api docs to internals	il y a 8 ans
internals_sysex_tools.md	ae7284edb8 rename api docs to internals	il y a 8 ans
isp_flashing_guide.md	c4d778a302 [Docs] Update ISP Guide (#9748)	il y a 6 ans
keycodes.md	b4ae7badd4 Issue 9942: Add LSA, RSA, RCS, LSA_T, RSA_T, and RCS_T (#9943)	il y a 6 ans
keycodes_basic.md	370577e4ed Add OPT aliases for ALT keycodes and macros (#8714)	il y a 6 ans
keycodes_us_ansi_shifted.md	40de65eac4 Backslash-escape pipe character in keycode lists (#7157)	il y a 6 ans
keymap.md	142ebaea46 [Docs] Clarify layer transparency keymap.md (#9081)	il y a 6 ans
mod_tap.md	370577e4ed Add OPT aliases for ALT keycodes and macros (#8714)	il y a 6 ans
newbs.md	45e218ceec overhaul the newbs guide	il y a 6 ans
newbs_building_firmware.md	54c58ea6de Add explicit id tags to externally linked headers	il y a 6 ans
newbs_building_firmware_configurator.md	d5f34c4810 Polish Configurator section	il y a 6 ans
newbs_flashing.md	9c8f61dfa0 [Docs] newbs_flashing.md: place bootloader instructions before Toolbox intro (#9077)	il y a 6 ans
newbs_getting_started.md	32340e14fb Update newbs MSYS2 pacman instructions (#9445)	il y a 6 ans
newbs_git_best_practices.md	3152bf572b [Docs] Restructure of Git Best Practices doc (#7231)	il y a 6 ans
newbs_git_resolving_merge_conflicts.md	3152bf572b [Docs] Restructure of Git Best Practices doc (#7231)	il y a 6 ans
newbs_git_resynchronize_a_branch.md	26a823082b [Docs] Fix minor differences in docs/newbs_git_resynchronize_a_branch.md (#7728)	il y a 6 ans
newbs_git_using_your_master_branch.md	54c58ea6de Add explicit id tags to externally linked headers	il y a 6 ans
newbs_learn_more_resources.md	45e218ceec overhaul the newbs guide	il y a 6 ans
newbs_testing_debugging.md	54c58ea6de Add explicit id tags to externally linked headers	il y a 6 ans
one_shot_keys.md	8e0af2f5ba [Docs] Fix link to mod_tap.md in the one_shot_keys.md file (#9380)	il y a 6 ans
other_eclipse.md	cde5237a88 fix two links on docs/other_eclipse.md (#8417)	il y a 6 ans
other_vscode.md	fb297a5644 [Docs] small text and formatting fixes in vscode manual (#9156)	il y a 6 ans
platformdev_chibios_earlyinit.md	93e7a8f74c Add dual-bank STM32 bootloader support, given GPIO toggle on BOOT0 to charge RC circuit. (#8778)	il y a 6 ans
platformdev_selecting_arm_mcu.md	3afd2d81b8 Add documentation for selecting an Arm MCU (#9046)	il y a 6 ans
power.txt	bb53635f33 Trim trailing whitespace	il y a 8 ans
pr_checklist.md	ac24f203cc Docs/PR_checklist: Reorder, unify and pet-peeves (#10253)	il y a 6 ans
proton_c_conversion.md	6d84795bc1 Update ARM split keyboard docs (#9160)	il y a 6 ans
qmk.css	ccc87421e7 Some more tweaks to make everything look nice	il y a 8 ans
qmk_custom_dark.css	1b267d4840 Fix darkmode (#8393)	il y a 6 ans
qmk_custom_light.css	1b267d4840 Fix darkmode (#8393)	il y a 6 ans
quantum_keycodes.md	54c58ea6de Add explicit id tags to externally linked headers	il y a 6 ans
redirects.json	d569f08771 Configuration system for CLI (#6708)	il y a 7 ans
ref_functions.md	5bd239e1c0 Remove unnecessary break after return from documentation (#9892)	il y a 6 ans
reference_configurator_support.md	d5f34c4810 Polish Configurator section	il y a 6 ans
reference_glossary.md	29ebb99b1f fixed link to Eclipse instructions (#9647)	il y a 6 ans
reference_info_json.md	bcb1815420 Add label to the info.json reference	il y a 7 ans
reference_keymap_extras.md	5f9fb01020 [Keymap Extra] Add French AZERTY (AFNOR - NF Z71-300) (#9644)	il y a 6 ans
serial_driver.md	6d84795bc1 Update ARM split keyboard docs (#9160)	il y a 6 ans
spi_driver.md	7aa4cc9603 adds support for the atmega328 (#9043)	il y a 6 ans
support.md	e4823aadec Fix capitalisation of "GitHub" (#9184)	il y a 6 ans
sw.js	303f425c6b Fix up info boxes.	il y a 8 ans
syllabus.md	9b70e53508 [Docs] Fixed minor typos (#8860)	il y a 6 ans
tap_hold.md	038a86a9b8 Add missing bracket for Tap-Hold code sample (#9675)	il y a 6 ans
translating.md	7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504)	il y a 6 ans
understanding_qmk.md	5117dff6a2 Add Post Processing to process_record (#4892)	il y a 6 ans
unit_testing.md	e02a3c559d Edit Unit Testing Documentation (#8961)	il y a 6 ans
usb_nkro.txt	995c3141a6 convert docs to lowercase and underscores	il y a 9 ans
ws2812_driver.md	c6b7a0d386 Add support for DMAMUX-capable MCU configuration with WS2812 PWM driver. (#9471)	il y a 6 ans

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