brickbots 833c5ae87a Buffer based OLED panning, write byte to buffer at arbitrary index (#8055)		6 жил өмнө
..
ChangeLog	26eef35f07 2020 February 29 Breaking Changes Update (#8064)	6 жил өмнө
de	54c58ea6de Add explicit id tags to externally linked headers	6 жил өмнө
es	54c58ea6de Add explicit id tags to externally linked headers	6 жил өмнө
fr-fr	54c58ea6de Add explicit id tags to externally linked headers	6 жил өмнө
gitbook	4580d3a730 RGB improvements (#1684)	9 жил өмнө
he-il	54c58ea6de Add explicit id tags to externally linked headers	6 жил өмнө
ja	54c58ea6de Add explicit id tags to externally linked headers	6 жил өмнө
pt-br	54c58ea6de Add explicit id tags to externally linked headers	6 жил өмнө
ru-ru	54c58ea6de Add explicit id tags to externally linked headers	6 жил өмнө
zh-cn	54c58ea6de Add explicit id tags to externally linked headers	6 жил өмнө
.nojekyll	9e5676650e Use docsfy to replace gitbook	8 жил өмнө
CNAME	4d26137e2a Create CNAME	8 жил өмнө
README.md	961477c791 make sure all our redirects are in order	6 жил өмнө
_langs.md	10e8ed7430 [Docs] add README translation in portuguese (#7016)	6 жил өмнө
_summary.md	76189d9a28 link the 2020 Feb 29 Breaking Changes changelog from the summary	6 жил өмнө
adc_driver.md	a8320f20f7 Improve support and docs for ADC driver (#7191)	6 жил өмнө
api_development_environment.md	99850aabca Add API documentation	6 жил өмнө
api_development_overview.md	99850aabca Add API documentation	6 жил өмнө
api_docs.md	99850aabca Add API documentation	6 жил өмнө
api_overview.md	99850aabca Add API documentation	6 жил өмнө
arm_debugging.md	52c18ef026 [Docs] fix docs (#7642)	6 жил өмнө
breaking_changes.md	f513a9193c Fix the Breaking Changes doc again	6 жил өмнө
breaking_changes_instructions.md	72d7661b30 suggestions by skullydazed	6 жил өмнө
cli.md	cdb5c074d3 remove some unnecessary external links	6 жил өмнө
cli_dev_configuration.md	86f6405574 More sidebar organization	6 жил өмнө
cli_development.md	f7bdc54c69 Add flake8 to our test suite and fix all errors (#7379)	6 жил өмнө
coding_conventions_c.md	f275ffbdfc Minor grammar and filename fixes in docs (#7559)	6 жил өмнө
coding_conventions_python.md	58d27cf404 Add a note explaining how to run tests	6 жил өмнө
compatible_microcontrollers.md	5414ff709f [Doc] Tidy up compatible MCUs docs (#7295)	6 жил өмнө
config_options.md	73728e9bec [Docs] Fix links in Config Options doc	6 жил өмнө
configurator_step_by_step.md	d5f34c4810 Polish Configurator section	6 жил өмнө
configurator_troubleshooting.md	d5f34c4810 Polish Configurator section	6 жил өмнө
contributing.md	54c58ea6de Add explicit id tags to externally linked headers	6 жил өмнө
custom_matrix.md	6e710426a4 Add docs for 'CUSTOM_MATRIX = lite' (#7906)	6 жил өмнө
custom_quantum_functions.md	54c58ea6de Add explicit id tags to externally linked headers	6 жил өмнө
documentation_best_practices.md	303f425c6b Fix up info boxes.	8 жил өмнө
documentation_templates.md	54c58ea6de Add explicit id tags to externally linked headers	6 жил өмнө
driver_installation_zadig.md	80ded60cad Add a short explanation to Zadig the troubleshooting section (#7110)	6 жил өмнө
eeprom_driver.md	d13ada1162 Add customisable EEPROM driver selection (#7274)	6 жил өмнө
faq_build.md	a52e55ec09 [Docs] Update macOS related issues in docs (#7744)	6 жил өмнө
faq_debug.md	770a4ee729 [Docs] Remove some outdated FAQ items (#7607)	6 жил өмнө
faq_general.md	a701c15d87 Rework the newbs guide around the qmk cli	6 жил өмнө
faq_keymap.md	12e43230c6 make custom_keycode_names.md a faq entry instead	6 жил өмнө
feature_advanced_keycodes.md	961477c791 make sure all our redirects are in order	6 жил өмнө
feature_audio.md	d534c72a54 Added keycodes for swapping and unswapping the Control and OS keys (#6110)	7 жил өмнө
feature_auto_shift.md	e9c44e396d Smallish overhaul of Auto-Shift feature (#6067)	6 жил өмнө
feature_backlight.md	54c58ea6de Add explicit id tags to externally linked headers	6 жил өмнө
feature_bluetooth.md	908aede957 Update feature_bluetooth.md (#7193)	6 жил өмнө
feature_bootmagic.md	54c58ea6de Add explicit id tags to externally linked headers	6 жил өмнө
feature_combo.md	57540af102 Change "yu" to "you" in combo docs (#6510)	7 жил өмнө
feature_command.md	a2e91ebec9 Update IS_COMMAND definitions to use MOD_MASK_SHIFT (#6348)	7 жил өмнө
feature_debounce_type.md	872744f5ab Update debounce docs (#7355)	6 жил өмнө
feature_dip_switch.md	dab4967f1b Add Dip Switch as a core feature (#6140)	7 жил өмнө
feature_dynamic_macros.md	542cb0a8ce [Core] Convert Dynamic Macro to a Core Feature (#5948)	6 жил өмнө
feature_encoders.md	26eef35f07 2020 February 29 Breaking Changes Update (#8064)	6 жил өмнө
feature_grave_esc.md	3510d8dc8d Document an annoyance with Grave Escape and macOS Terminal (#5483)	7 жил өмнө
feature_haptic_feedback.md	f275ffbdfc Minor grammar and filename fixes in docs (#7559)	6 жил өмнө
feature_hd44780.md	b23f6011c3 Remove build option firmware size impacts (#6947)	6 жил өмнө
feature_key_lock.md	54c58ea6de Add explicit id tags to externally linked headers	6 жил өмнө
feature_layouts.md	40e67a3074 Add a mechanism for force building a particular community layout (#5027)	7 жил өмнө
feature_leader_key.md	54c58ea6de Add explicit id tags to externally linked headers	6 жил өмнө
feature_led_matrix.md	24df54b807 Add documentation for led matrix	7 жил өмнө
feature_macros.md	444fd3b1cc Add support for delays in send_string. (#8244)	6 жил өмнө
feature_mouse_keys.md	4856552f8b Update mouse keys docs (#5653)	7 жил өмнө
feature_oled_driver.md	833c5ae87a Buffer based OLED panning, write byte to buffer at arbitrary index (#8055)	6 жил өмнө
feature_pointing_device.md	af37bb2f78 Fix some of the more obvious typos	8 жил өмнө
feature_ps2_mouse.md	c73d6f6ac8 [Docs] Removed dead link (#6922)	6 жил өмнө
feature_rgb_matrix.md	a1452db98a Configuration values for starting HSV and speed (#7740)	6 жил өмнө
feature_rgblight.md	f9521ffa21 Add shift-to-invert to remaining directional RGB_* keycode pairs (#7484)	6 жил өмнө
feature_space_cadet.md	d16db69367 Added mod carry over from press to release. (#5866)	7 жил өмнө
feature_split_keyboard.md	307be48de9 Reduce SPLIT_USB_TIMEOUT by 500ms (#7637)	6 жил өмнө
feature_stenography.md	c0baf2a964 Improve state/chord handling and clean up namespace	8 жил өмнө
feature_swap_hands.md	fd085837e1 fix swap_hands keycodes in documentation (#3588)	8 жил өмнө
feature_tap_dance.md	54c58ea6de Add explicit id tags to externally linked headers	6 жил өмнө
feature_terminal.md	b23f6011c3 Remove build option firmware size impacts (#6947)	6 жил өмнө
feature_thermal_printer.md	4c675a83ba Format keycode tables	8 жил өмнө
feature_unicode.md	bb8d4b4d23 `send_unicode_string()`: Add support for code points > 0xFFFF (#8236)	6 жил өмнө
feature_userspace.md	5a6737a778 Send string keycode tweaks (#7471)	6 жил өмнө
feature_velocikey.md	c1c5922aae Velocikey: Match RGB animation speed to typing speed (#3754)	7 жил өмнө
flashing.md	3c98854044 update flashing.md	6 жил өмнө
flashing_bootloadhid.md	235da6973d Install bootloadHid as part of qmk_install (#7463)	6 жил өмнө
fuse.txt	ca01d94005 convert docs to lowercase and underscores	9 жил өмнө
getting_started_introduction.md	09c7304bd9 [Docs] update git command and directory name of documents (#7619)	6 жил өмнө
getting_started_make_guide.md	6e710426a4 Add docs for 'CUSTOM_MATRIX = lite' (#7906)	6 жил өмнө
getting_started_vagrant.md	dfdd9e821b [Docs] Update getting_started_vagrant.md (#7203)	6 жил өмнө
hand_wire.md	961477c791 make sure all our redirects are in order	6 жил өмнө
hardware_avr.md	f87908228a Remove apostrophe from various abbreviations' plural forms (#7050)	6 жил өмнө
hardware_drivers.md	d13ada1162 Add customisable EEPROM driver selection (#7274)	6 жил өмнө
hardware_keyboard_guidelines.md	de386e5972 Fixed typos in documentation (#6871)	6 жил өмнө
how_a_matrix_works.md	a95a314f78 refactor How a Matrix Works doc	6 жил өмнө
how_keyboards_work.md	d5316e9714 Update URL for `60-keyboard.hwdb` (#7185)	6 жил өмнө
i2c_driver.md	e6a6b1f122 [Docs] Update i2c_driver.md (#6665)	7 жил өмнө
index.html	961477c791 make sure all our redirects are in order	6 жил өмнө
internals_defines.md	ae7284edb8 rename api docs to internals	8 жил өмнө
internals_gpio_control.md	403c139b34 [Docs] Add AVR and ARM examples to GPIO Commands (#6942)	6 жил өмнө
internals_input_callback_reg.md	ae7284edb8 rename api docs to internals	8 жил өмнө
internals_midi_device.md	ae7284edb8 rename api docs to internals	8 жил өмнө
internals_midi_device_setup_process.md	ae7284edb8 rename api docs to internals	8 жил өмнө
internals_midi_util.md	ae7284edb8 rename api docs to internals	8 жил өмнө
internals_send_functions.md	ae7284edb8 rename api docs to internals	8 жил өмнө
internals_sysex_tools.md	ae7284edb8 rename api docs to internals	8 жил өмнө
isp_flashing_guide.md	abd36de5ad [Docs] Update ISP Flashing guide (#8149)	6 жил өмнө
keycodes.md	2939751eb3 keycodes.md: hard-code section link id attributes	6 жил өмнө
keycodes_basic.md	606813b72d Remove obsolete note about media keys in MacOS (#6631)	6 жил өмнө
keycodes_us_ansi_shifted.md	40de65eac4 Backslash-escape pipe character in keycode lists (#7157)	6 жил өмнө
keymap.md	54c58ea6de Add explicit id tags to externally linked headers	6 жил өмнө
mod_tap.md	9035c3497e break feature_advanced_keycodes.md up into multiple files	6 жил өмнө
newbs.md	45e218ceec overhaul the newbs guide	6 жил өмнө
newbs_building_firmware.md	54c58ea6de Add explicit id tags to externally linked headers	6 жил өмнө
newbs_building_firmware_configurator.md	d5f34c4810 Polish Configurator section	6 жил өмнө
newbs_flashing.md	54c58ea6de Add explicit id tags to externally linked headers	6 жил өмнө
newbs_getting_started.md	54c58ea6de Add explicit id tags to externally linked headers	6 жил өмнө
newbs_git_best_practices.md	3152bf572b [Docs] Restructure of Git Best Practices doc (#7231)	6 жил өмнө
newbs_git_resolving_merge_conflicts.md	3152bf572b [Docs] Restructure of Git Best Practices doc (#7231)	6 жил өмнө
newbs_git_resynchronize_a_branch.md	26a823082b [Docs] Fix minor differences in docs/newbs_git_resynchronize_a_branch.md (#7728)	6 жил өмнө
newbs_git_using_your_master_branch.md	54c58ea6de Add explicit id tags to externally linked headers	6 жил өмнө
newbs_learn_more_resources.md	45e218ceec overhaul the newbs guide	6 жил өмнө
newbs_testing_debugging.md	54c58ea6de Add explicit id tags to externally linked headers	6 жил өмнө
one_shot_keys.md	9035c3497e break feature_advanced_keycodes.md up into multiple files	6 жил өмнө
other_eclipse.md	54c58ea6de Add explicit id tags to externally linked headers	6 жил өмнө
other_vscode.md	e9ace14878 [Docs] Add VSCode guide to docs (#5124)	7 жил өмнө
power.txt	bb53635f33 Trim trailing whitespace	8 жил өмнө
proton_c_conversion.md	1af31a0523 Update feature support for Proton C (#7596)	6 жил өмнө
qmk.css	ccc87421e7 Some more tweaks to make everything look nice	8 жил өмнө
quantum_keycodes.md	54c58ea6de Add explicit id tags to externally linked headers	6 жил өмнө
redirects.json	d569f08771 Configuration system for CLI (#6708)	7 жил өмнө
ref_functions.md	54c58ea6de Add explicit id tags to externally linked headers	6 жил өмнө
reference_configurator_support.md	d5f34c4810 Polish Configurator section	6 жил өмнө
reference_glossary.md	f87908228a Remove apostrophe from various abbreviations' plural forms (#7050)	6 жил өмнө
reference_info_json.md	bcb1815420 Add label to the info.json reference	7 жил өмнө
sidebar.css	3bd65d2173 CSS updates: ul and pre elements	6 жил өмнө
support.md	961477c791 make sure all our redirects are in order	6 жил өмнө
sw.js	303f425c6b Fix up info boxes.	8 жил өмнө
tap_hold.md	4e826ba61f Correct typo in tap_hold.md (#8326)	6 жил өмнө
translating.md	7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504)	6 жил өмнө
understanding_qmk.md	f87908228a Remove apostrophe from various abbreviations' plural forms (#7050)	6 жил өмнө
unit_testing.md	54c58ea6de Add explicit id tags to externally linked headers	6 жил өмнө
usb_nkro.txt	995c3141a6 convert docs to lowercase and underscores	9 жил өмнө
ws2812_driver.md	f74c769a19 PWM DMA based RGB Underglow for STM32 (#7928)	6 жил өмнө

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