QMK Bot 54534fe5b2 Merge remote-tracking branch 'origin/master' into develop 5 yıl önce
..
ChangeLog 6caebb7b61 Bootmagic lite docs clarity. (#14204) 5 yıl önce
de 596c4a1f87 Remove bin/qmk (#14231) 5 yıl önce
es ce379ef458 Merge remote-tracking branch 'origin/master' into develop 5 yıl önce
fr-fr 596c4a1f87 Remove bin/qmk (#14231) 5 yıl önce
gitbook 4580d3a730 RGB improvements (#1684) 9 yıl önce
he-il c71d67ba3f [Core] [Docs] Remove travis-ci references (#13916) 5 yıl önce
ja 0fa217a5b7 Align ChibiOS I2C defs with other drivers (#14399) 5 yıl önce
ko-kr c71d67ba3f [Core] [Docs] Remove travis-ci references (#13916) 5 yıl önce
pt-br c71d67ba3f [Core] [Docs] Remove travis-ci references (#13916) 5 yıl önce
ru-ru c71d67ba3f [Core] [Docs] Remove travis-ci references (#13916) 5 yıl önce
zh-cn ce379ef458 Merge remote-tracking branch 'origin/master' into develop 5 yıl önce
.nojekyll 9e5676650e Use docsfy to replace gitbook 8 yıl önce
CNAME 4d26137e2a Create CNAME 8 yıl önce
README.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 yıl önce
_langs.md 10e8ed7430 [Docs] add README translation in portuguese (#7016) 6 yıl önce
_summary.md 75b49aff56 Digitizer HID interface : absolute coordinates for mouse cursor (#12851) 5 yıl önce
adc_driver.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 5 yıl önce
api_development_environment.md 99850aabca Add API documentation 6 yıl önce
api_development_overview.md 99850aabca Add API documentation 6 yıl önce
api_docs.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 yıl önce
api_overview.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 yıl önce
arm_debugging.md 52c18ef026 [Docs] fix docs (#7642) 6 yıl önce
audio_driver.md b56282756b [Docs] Clean up some code block languages (#14434) 5 yıl önce
breaking_changes.md 4bad375d7c 2021Q3 pre-merge `develop` changelog, keyboard aliases (#14198) 5 yıl önce
breaking_changes_history.md 4bad375d7c 2021Q3 pre-merge `develop` changelog, keyboard aliases (#14198) 5 yıl önce
breaking_changes_instructions.md fced377ac0 2020 May 30 Breaking Changes Update (#9215) 6 yıl önce
chibios_upgrade_instructions.md 554c36a055 Update ChibiOS, ChibiOS-Contrib. (#13056) 5 yıl önce
cli.md fcf150bd82 Streamline the macos install process 6 yıl önce
cli_commands.md f155865804 remove qmk console, which is now part of the global cli (#14206) 5 yıl önce
cli_configuration.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 yıl önce
cli_development.md b56282756b [Docs] Clean up some code block languages (#14434) 5 yıl önce
cli_tab_complete.md 588bcdc8ca Add support for tab completion (#12411) 5 yıl önce
coding_conventions_c.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 yıl önce
coding_conventions_python.md 66d94dc22a Move everything to Python 3.6 (#8835) 6 yıl önce
compatible_microcontrollers.md b43c6bc176 Add support for STM32F407x MCUs. (#13718) 5 yıl önce
config_options.md d5cb7de5e4 Change USBasp and bootloadHID bootloaders to lowercase (#14354) 5 yıl önce
configurator_architecture.md 9a0118c603 Architecture documentation for Configurator and API (#13935) 5 yıl önce
configurator_default_keymaps.md b56282756b [Docs] Clean up some code block languages (#14434) 5 yıl önce
configurator_diagram.drawio 9a0118c603 Architecture documentation for Configurator and API (#13935) 5 yıl önce
configurator_diagram.svg 9a0118c603 Architecture documentation for Configurator and API (#13935) 5 yıl önce
configurator_step_by_step.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 yıl önce
configurator_troubleshooting.md d5f34c4810 Polish Configurator section 6 yıl önce
contributing.md 596c4a1f87 Remove bin/qmk (#14231) 5 yıl önce
custom_matrix.md b56282756b [Docs] Clean up some code block languages (#14434) 5 yıl önce
custom_quantum_functions.md a03aa301de Remove Full Bootmagic (#13846) 5 yıl önce
data_driven_config.md ef6329af7c Create a system to map between info.json and config.h/rules.mk (#11548) 5 yıl önce
documentation_best_practices.md 995464cb9c [Docs] fix file path (#9540) 6 yıl önce
documentation_templates.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 yıl önce
driver_installation_zadig.md d5cb7de5e4 Change USBasp and bootloadHID bootloaders to lowercase (#14354) 5 yıl önce
easy_maker.md 60a36863bc [Keyboard] ez_maker/directpins for easy one-offs in qmk_configurator (#13321) 5 yıl önce
eeprom_driver.md dd16d3cc7e eeprom_i2c driver: added EXTERNAL_EEPROM_WP_PIN configuration option. (#12617) 5 yıl önce
faq_build.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 yıl önce
faq_debug.md b56282756b [Docs] Clean up some code block languages (#14434) 5 yıl önce
faq_general.md d6701b3ac7 Fix typos and reword some sentences in FAQs (#11546) 5 yıl önce
faq_keymap.md bb356a1584 [Docs] Update path to keycode.h (#14263) 5 yıl önce
faq_misc.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 yıl önce
feature_advanced_keycodes.md 92dd1b977b Additional documentation for GUI mod combo (#13266) 5 yıl önce
feature_audio.md 4e3726bfe1 Fixup Audio startup and add to documents (#13606) 5 yıl önce
feature_auto_shift.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 5 yıl önce
feature_backlight.md b56282756b [Docs] Clean up some code block languages (#14434) 5 yıl önce
feature_bluetooth.md b56282756b [Docs] Clean up some code block languages (#14434) 5 yıl önce
feature_bootmagic.md a03aa301de Remove Full Bootmagic (#13846) 5 yıl önce
feature_combo.md 7e983796e1 Process combos earlier & overlapping combos (#8591) 5 yıl önce
feature_command.md a03aa301de Remove Full Bootmagic (#13846) 5 yıl önce
feature_debounce_type.md c0628c2820 Remove backwards compatibility of debounce names (#13877) 5 yıl önce
feature_digitizer.md b56282756b [Docs] Clean up some code block languages (#14434) 5 yıl önce
feature_dip_switch.md 9d1c98c891 Added right vs left specific pin assignments for dip switch (#13074) 5 yıl önce
feature_dynamic_macros.md cdb69da86e Fix typo in docs/feature_dynamic_macros (#10085) 6 yıl önce
feature_encoders.md 703f027717 Allow for removal of hysteresis on 4x encoders (#13698) 5 yıl önce
feature_grave_esc.md 3510d8dc8d Document an annoyance with Grave Escape and macOS Terminal (#5483) 7 yıl önce
feature_haptic_feedback.md e4c5b1bbbb Add Per Key exclusions for Haptic Feedback (#12386) 5 yıl önce
feature_hd44780.md d846660e00 fixed typo for clear lcd screen function in hd44780 docs (#9086) 6 yıl önce
feature_joystick.md b56282756b [Docs] Clean up some code block languages (#14434) 5 yıl önce
feature_key_lock.md 54c58ea6de Add explicit id tags to externally linked headers 6 yıl önce
feature_key_overrides.md 1e7117317f Documentation: Fix links in key overrides (#14228) 5 yıl önce
feature_layers.md eac9ee8d3f Improve upon the 'Caveats' section of the Layers and Mod-Tap documentation (#12306) 5 yıl önce
feature_layouts.md b56282756b [Docs] Clean up some code block languages (#14434) 5 yıl önce
feature_leader_key.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 5 yıl önce
feature_led_indicators.md 8f6867ce95 [Docs] Added note about no split support (#12512) 5 yıl önce
feature_led_matrix.md 7f80076d04 Align rgb/led matrix docs with current behaviour (#14367) 5 yıl önce
feature_macros.md 2395069b0b [Docs] New section to modifier docs: Checking Modifier State (#10550) 5 yıl önce
feature_midi.md b56282756b [Docs] Clean up some code block languages (#14434) 5 yıl önce
feature_mouse_keys.md 99f3df2893 Add support for 8 buttons to mouse report (#10807) 5 yıl önce
feature_oled_driver.md 657323a206 [Docs] fixed incorrect amount of steps for oled usage (#13519) 5 yıl önce
feature_pointing_device.md b56282756b [Docs] Clean up some code block languages (#14434) 5 yıl önce
feature_ps2_mouse.md b56282756b [Docs] Clean up some code block languages (#14434) 5 yıl önce
feature_rawhid.md b56282756b [Docs] Clean up some code block languages (#14434) 5 yıl önce
feature_rgb_matrix.md b56282756b [Docs] Clean up some code block languages (#14434) 5 yıl önce
feature_rgblight.md fb9a254a43 Retain brightness with lighting layers (#13025) 5 yıl önce
feature_sequencer.md 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 yıl önce
feature_space_cadet.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 yıl önce
feature_split_keyboard.md 0ae20e7457 Make solo half of split keyboards (more) usable. (#13523) 5 yıl önce
feature_st7565.md 37fba09021 ST7565 invert (#13237) 5 yıl önce
feature_stenography.md b56282756b [Docs] Clean up some code block languages (#14434) 5 yıl önce
feature_swap_hands.md b56282756b [Docs] Clean up some code block languages (#14434) 5 yıl önce
feature_tap_dance.md 03d258c222 matrix_scan_x -> x_task (#13748) 5 yıl önce
feature_terminal.md b23f6011c3 Remove build option firmware size impacts (#6947) 7 yıl önce
feature_thermal_printer.md 4c675a83ba Format keycode tables 8 yıl önce
feature_unicode.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 5 yıl önce
feature_userspace.md b56282756b [Docs] Clean up some code block languages (#14434) 5 yıl önce
feature_velocikey.md 8a8fdd9a72 Highlight keycode (#14317) 5 yıl önce
feature_wpm.md aeff347a07 Update feature_wpm.md (#13936) 5 yıl önce
flashing.md d5cb7de5e4 Change USBasp and bootloadHID bootloaders to lowercase (#14354) 5 yıl önce
flashing_bootloadhid.md b56282756b [Docs] Clean up some code block languages (#14434) 5 yıl önce
fuse.txt 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 yıl önce
getting_started_docker.md b56282756b [Docs] Clean up some code block languages (#14434) 5 yıl önce
getting_started_github.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 yıl önce
getting_started_introduction.md 09c7304bd9 [Docs] update git command and directory name of documents (#7619) 6 yıl önce
getting_started_make_guide.md d5cb7de5e4 Change USBasp and bootloadHID bootloaders to lowercase (#14354) 5 yıl önce
getting_started_vagrant.md b56282756b [Docs] Clean up some code block languages (#14434) 5 yıl önce
hand_wire.md 6fd9b2feba [Docs] Added information on soldering diodes in parallel (#13117) 5 yıl önce
hardware_avr.md b021c2f2c5 Port new_keyboard.sh to CLI (#13706) 5 yıl önce
hardware_drivers.md d13ada1162 Add customisable EEPROM driver selection (#7274) 6 yıl önce
hardware_keyboard_guidelines.md b56282756b [Docs] Clean up some code block languages (#14434) 5 yıl önce
how_a_matrix_works.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 yıl önce
how_keyboards_work.md b56282756b [Docs] Clean up some code block languages (#14434) 5 yıl önce
i2c_driver.md 0fa217a5b7 Align ChibiOS I2C defs with other drivers (#14399) 5 yıl önce
index.html bbf0f65284 Simplify the visual flow of the getting started page (#11316) 5 yıl önce
internals_defines.md ae7284edb8 rename api docs to internals 8 yıl önce
internals_gpio_control.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 yıl önce
internals_input_callback_reg.md ae7284edb8 rename api docs to internals 8 yıl önce
internals_midi_device.md ae7284edb8 rename api docs to internals 8 yıl önce
internals_midi_device_setup_process.md ae7284edb8 rename api docs to internals 8 yıl önce
internals_midi_util.md ae7284edb8 rename api docs to internals 8 yıl önce
internals_send_functions.md ae7284edb8 rename api docs to internals 8 yıl önce
internals_sysex_tools.md ae7284edb8 rename api docs to internals 8 yıl önce
isp_flashing_guide.md 9d1d875a95 [Docs] Update isp_flashing_guide.md (#11777) 5 yıl önce
keycodes.md a03aa301de Remove Full Bootmagic (#13846) 5 yıl önce
keycodes_basic.md 962b8d3814 Update keycode docs (#11343) 5 yıl önce
keycodes_magic.md 4c4f632378 Add a toggle key for GUI On/Off in Magic feature (#13830) 5 yıl önce
keycodes_us_ansi_shifted.md 40de65eac4 Backslash-escape pipe character in keycode lists (#7157) 6 yıl önce
keymap.md 142ebaea46 [Docs] Clarify layer transparency keymap.md (#9081) 6 yıl önce
mod_tap.md 7e832e46de Add Mac centric Shift and Alt + GUI Macros (#13107) 5 yıl önce
newbs.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 yıl önce
newbs_building_firmware.md 54c58ea6de Add explicit id tags to externally linked headers 6 yıl önce
newbs_building_firmware_configurator.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 yıl önce
newbs_flashing.md 0f516d9026 A few small typo fixes in docs (#12524) 5 yıl önce
newbs_getting_started.md 189e0d5b98 Update FreeBSD install method (#12815) 5 yıl önce
newbs_git_best_practices.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) 6 yıl önce
newbs_git_resolving_merge_conflicts.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) 6 yıl önce
newbs_git_resynchronize_a_branch.md b56282756b [Docs] Clean up some code block languages (#14434) 5 yıl önce
newbs_git_using_your_master_branch.md 54c58ea6de Add explicit id tags to externally linked headers 6 yıl önce
newbs_learn_more_resources.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 yıl önce
newbs_testing_debugging.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 yıl önce
one_shot_keys.md fcce9f2a4f fix: Fix typo in documentation for one shot keys. ON_TOGG -> OS_TOGG (#13754) 5 yıl önce
other_eclipse.md cfbd9ba0e7 eclipse: recommend changing the default project make target (#12447) 5 yıl önce
other_vscode.md c71d67ba3f [Core] [Docs] Remove travis-ci references (#13916) 5 yıl önce
platformdev_chibios_earlyinit.md 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 yıl önce
platformdev_selecting_arm_mcu.md 3afd2d81b8 Add documentation for selecting an Arm MCU (#9046) 6 yıl önce
power.txt bb53635f33 Trim trailing whitespace 8 yıl önce
pr_checklist.md b459f314ec Explicitly state that VIA should not be enabled in the default keymap. (#13803) 5 yıl önce
proton_c_conversion.md 87291437bd Add board specific to Proton-C, with usual defaults turned on. (#10976) 5 yıl önce
qmk.css ccc87421e7 Some more tweaks to make everything look nice 8 yıl önce
qmk_custom_dark.css 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 yıl önce
qmk_custom_light.css 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 yıl önce
quantum_keycodes.md 54c58ea6de Add explicit id tags to externally linked headers 6 yıl önce
redirects.json d569f08771 Configuration system for CLI (#6708) 7 yıl önce
ref_functions.md a03aa301de Remove Full Bootmagic (#13846) 5 yıl önce
reference_configurator_support.md 25f43837d2 Remove references to info.json `width` and `height` in CLI (#13728) 5 yıl önce
reference_glossary.md 014aa0661e Fix Space Cadet md link (#14300) 5 yıl önce
reference_info_json.md 4791cfae1a Remove width, height and key_count from info.json (#14274) 5 yıl önce
reference_keymap_extras.md fce12f0075 Rework keymap_extras docs (#13949) 5 yıl önce
serial_driver.md 0ae20e7457 Make solo half of split keyboards (more) usable. (#13523) 5 yıl önce
spi_driver.md 0e59827023 Merge remote-tracking branch 'upstream/master' into develop 5 yıl önce
support.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 yıl önce
sw.js 303f425c6b Fix up info boxes. 8 yıl önce
syllabus.md a03aa301de Remove Full Bootmagic (#13846) 5 yıl önce
tap_hold.md 610035dce8 Add HOLD_ON_OTHER_KEY_PRESS option for dual-role keys (#9404) 5 yıl önce
translating.md 7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) 6 yıl önce
uart_driver.md 30b46fad57 UART driver refactor (#11637) 5 yıl önce
understanding_qmk.md 52cfc9259b [Feature] Key Overrides (#11422) 5 yıl önce
unit_testing.md b56282756b [Docs] Clean up some code block languages (#14434) 5 yıl önce
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores 9 yıl önce
ws2812_driver.md 597d2e0e7b Fix up WS2812 SPI driver on F072. (#13022) 5 yıl önce

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](newbs_building_firmware_configurator.md)
User friendly graphical interfaces, no programming knowledge required. ?> **Advanced** [Use The Source](newbs.md)
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.