1
0
QMK Bot 70cc5809f9 Merge remote-tracking branch 'origin/master' into develop 5 жил өмнө
..
ChangeLog 275996f4c1 Add changelog for 2021-05-29 Breaking Changes merge (#12939) 5 жил өмнө
de 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 жил өмнө
es 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 жил өмнө
fr-fr 59c572eaf0 Cleanup junk characters, part 1 (#13282) 5 жил өмнө
gitbook 4580d3a730 RGB improvements (#1684) 9 жил өмнө
he-il 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 жил өмнө
ja 70cc5809f9 Merge remote-tracking branch 'origin/master' into develop 5 жил өмнө
ko-kr 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 жил өмнө
pt-br 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 жил өмнө
ru-ru 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 жил өмнө
zh-cn 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 жил өмнө
.nojekyll 9e5676650e Use docsfy to replace gitbook 8 жил өмнө
CNAME 4d26137e2a Create CNAME 8 жил өмнө
README.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 жил өмнө
_langs.md 10e8ed7430 [Docs] add README translation in portuguese (#7016) 6 жил өмнө
_summary.md b2fdd48744 Add ST7565 LCD driver (#13089) 5 жил өмнө
adc_driver.md 65c9752762 Update ADC driver for STM32F1xx, STM32F3xx, STM32F4xx (#12403) 5 жил өмнө
api_development_environment.md 99850aabca Add API documentation 6 жил өмнө
api_development_overview.md 99850aabca Add API documentation 6 жил өмнө
api_docs.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 жил өмнө
api_overview.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 жил өмнө
arm_debugging.md 52c18ef026 [Docs] fix docs (#7642) 6 жил өмнө
audio_driver.md c80e5f9f88 Audio system overhaul (#11820) 5 жил өмнө
breaking_changes.md e3030bff5e Merge remote-tracking branch 'upstream/master' into develop 5 жил өмнө
breaking_changes_history.md 275996f4c1 Add changelog for 2021-05-29 Breaking Changes merge (#12939) 5 жил өмнө
breaking_changes_instructions.md fced377ac0 2020 May 30 Breaking Changes Update (#9215) 6 жил өмнө
chibios_upgrade_instructions.md 554c36a055 Update ChibiOS, ChibiOS-Contrib. (#13056) 5 жил өмнө
cli.md fcf150bd82 Streamline the macos install process 6 жил өмнө
cli_commands.md cb23fe9fc1 Move RGBLight code into its own folder (#13312) 5 жил өмнө
cli_configuration.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 жил өмнө
cli_development.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 жил өмнө
cli_tab_complete.md 588bcdc8ca Add support for tab completion (#12411) 5 жил өмнө
coding_conventions_c.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 жил өмнө
coding_conventions_python.md 66d94dc22a Move everything to Python 3.6 (#8835) 6 жил өмнө
compatible_microcontrollers.md 8bb231aa1c Adds support for STM32L412xB, STM32L422xB. (#13383) 5 жил өмнө
config_options.md 172e6a7030 Extensible split data sync (#11930) 5 жил өмнө
configurator_default_keymaps.md de68d294ec [Docs] add "Adding Default Keymaps to QMK Configurator" doc (#10049) 5 жил өмнө
configurator_step_by_step.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 жил өмнө
configurator_troubleshooting.md d5f34c4810 Polish Configurator section 6 жил өмнө
contributing.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 жил өмнө
custom_matrix.md 6e710426a4 Add docs for 'CUSTOM_MATRIX = lite' (#7906) 6 жил өмнө
custom_quantum_functions.md f287597c19 Use single memcmp to determine if matrix changed. (#13064) 5 жил өмнө
data_driven_config.md ef6329af7c Create a system to map between info.json and config.h/rules.mk (#11548) 5 жил өмнө
documentation_best_practices.md 995464cb9c [Docs] fix file path (#9540) 6 жил өмнө
documentation_templates.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 жил өмнө
driver_installation_zadig.md 10096fc42e Zadig docs: add APM32 device name (#11356) 5 жил өмнө
eeprom_driver.md dd16d3cc7e eeprom_i2c driver: added EXTERNAL_EEPROM_WP_PIN configuration option. (#12617) 5 жил өмнө
faq_build.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 жил өмнө
faq_debug.md 4c3090ace9 Documentation changes SPLIT_USB_DETECT and hid_listen udev rules (#11665) 5 жил өмнө
faq_general.md d6701b3ac7 Fix typos and reword some sentences in FAQs (#11546) 5 жил өмнө
faq_keymap.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 жил өмнө
faq_misc.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 жил өмнө
feature_advanced_keycodes.md 92dd1b977b Additional documentation for GUI mod combo (#13266) 5 жил өмнө
feature_audio.md 2538d341d8 Document user song list file (#13101) 5 жил өмнө
feature_auto_shift.md c02137a0d2 Add Per Key functionality for AutoShift (#11536) 5 жил өмнө
feature_backlight.md 06aea834c4 Backlight: add defines for default level and breathing state (#12560) 5 жил өмнө
feature_bluetooth.md 0fbb1e550a Add description in Bluetooth docs for requiring NKRO to be disabled (#10359) 5 жил өмнө
feature_bootmagic.md 789e199450 Add support for Bootmagic lite when using SPLIT_HAND_PIN (#8347) 6 жил өмнө
feature_combo.md 49abff9071 changed type of process_combo_event argument in tutorial (#10621) 5 жил өмнө
feature_command.md a2e91ebec9 Update IS_COMMAND definitions to use MOD_MASK_SHIFT (#6348) 7 жил өмнө
feature_debounce_type.md a0959f1b33 Add asym_eager_defer_pk debounce type (#12689) 5 жил өмнө
feature_dip_switch.md c2ca57c8f4 add DIP_SWITCH_MATRIX_GRID support (#8772) 6 жил өмнө
feature_dynamic_macros.md cdb69da86e Fix typo in docs/feature_dynamic_macros (#10085) 6 жил өмнө
feature_encoders.md a0fed0ea17 Convert Encoder callbacks to be boolean functions (#12805) 5 жил өмнө
feature_grave_esc.md 3510d8dc8d Document an annoyance with Grave Escape and macOS Terminal (#5483) 7 жил өмнө
feature_haptic_feedback.md e4c5b1bbbb Add Per Key exclusions for Haptic Feedback (#12386) 5 жил өмнө
feature_hd44780.md d846660e00 fixed typo for clear lcd screen function in hd44780 docs (#9086) 6 жил өмнө
feature_joystick.md c66df16644 2020 November 28 Breaking Changes Update (#11053) 5 жил өмнө
feature_key_lock.md 54c58ea6de Add explicit id tags to externally linked headers 6 жил өмнө
feature_layers.md eac9ee8d3f Improve upon the 'Caveats' section of the Layers and Mod-Tap documentation (#12306) 5 жил өмнө
feature_layouts.md 40e67a3074 Add a mechanism for force building a particular community layout (#5027) 7 жил өмнө
feature_leader_key.md 26b9b3aa23 feat: infinite timeout for leader key (#6580) 5 жил өмнө
feature_led_indicators.md 1ff5ee255f Indicator LEDs as config (#10816) 5 жил өмнө
feature_led_matrix.md 875bb48a20 Top level heading for common config (LED Matrix) (#13153) 5 жил өмнө
feature_macros.md 2395069b0b [Docs] New section to modifier docs: Checking Modifier State (#10550) 5 жил өмнө
feature_midi.md b10728edc1 [Docs] added basic midi documention of common features (#13113) 5 жил өмнө
feature_mouse_keys.md 99f3df2893 Add support for 8 buttons to mouse report (#10807) 5 жил өмнө
feature_oled_driver.md 0311c8036d Add oled_invert (#13172) 5 жил өмнө
feature_pointing_device.md 711388d3e3 Merge remote-tracking branch 'origin/master' into develop 5 жил өмнө
feature_ps2_mouse.md 92543a7cb5 fix(feature_ps2_mouse): fix Scroll Button example (#11669) 5 жил өмнө
feature_rawhid.md dee506c096 Updated Raw HID docs to clarify packet/report length (#11211) 5 жил өмнө
feature_rgb_matrix.md 653082235a Relocate RGB/HSV color defs to a more fitting place (#13377) 5 жил өмнө
feature_rgblight.md 653082235a Relocate RGB/HSV color defs to a more fitting place (#13377) 5 жил өмнө
feature_sequencer.md 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 жил өмнө
feature_space_cadet.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 жил өмнө
feature_split_keyboard.md 172e6a7030 Extensible split data sync (#11930) 5 жил өмнө
feature_st7565.md 37fba09021 ST7565 invert (#13237) 5 жил өмнө
feature_stenography.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 жил өмнө
feature_swap_hands.md f0b30e0027 Make Swap Hands use PROGMEM (#12284) 5 жил өмнө
feature_tap_dance.md 653ecf91c2 More Tap Dance docs improvements (#12358) 5 жил өмнө
feature_terminal.md b23f6011c3 Remove build option firmware size impacts (#6947) 6 жил өмнө
feature_thermal_printer.md 4c675a83ba Format keycode tables 8 жил өмнө
feature_unicode.md 04ab5de73c Deprecate `send_unicode_hex_string()` (#12602) 5 жил өмнө
feature_userspace.md 501f2fdef1 Normalise include statements in core code (#11153) 5 жил өмнө
feature_velocikey.md c1c5922aae Velocikey: Match RGB animation speed to typing speed (#3754) 7 жил өмнө
feature_wpm.md 180a32ec59 Enhancement of WPM feature (#11727) 5 жил өмнө
flashing.md 891d18d356 Add initial support for tinyuf2 bootloader (when hosted on F411 blackpill) (#12600) 5 жил өмнө
flashing_bootloadhid.md 235da6973d Install bootloadHid as part of qmk_install (#7463) 6 жил өмнө
fuse.txt 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 жил өмнө
getting_started_docker.md e4d3ff2374 Add support for using podman to util/docker_build.sh (#10819) 5 жил өмнө
getting_started_github.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 жил өмнө
getting_started_introduction.md 09c7304bd9 [Docs] update git command and directory name of documents (#7619) 6 жил өмнө
getting_started_make_guide.md b23eeb6a14 Documentation update (#12484) 5 жил өмнө
getting_started_vagrant.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 жил өмнө
hand_wire.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 жил өмнө
hardware_avr.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 жил өмнө
hardware_drivers.md d13ada1162 Add customisable EEPROM driver selection (#7274) 6 жил өмнө
hardware_keyboard_guidelines.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 жил өмнө
how_a_matrix_works.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 жил өмнө
how_keyboards_work.md d5316e9714 Update URL for `60-keyboard.hwdb` (#7185) 6 жил өмнө
i2c_driver.md 5d5cbb877d Rework I2C driver docs (#11658) 5 жил өмнө
index.html bbf0f65284 Simplify the visual flow of the getting started page (#11316) 5 жил өмнө
internals_defines.md ae7284edb8 rename api docs to internals 8 жил өмнө
internals_gpio_control.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 жил өмнө
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 9d1d875a95 [Docs] Update isp_flashing_guide.md (#11777) 5 жил өмнө
keycodes.md 7e832e46de Add Mac centric Shift and Alt + GUI Macros (#13107) 5 жил өмнө
keycodes_basic.md 962b8d3814 Update keycode docs (#11343) 5 жил өмнө
keycodes_us_ansi_shifted.md 40de65eac4 Backslash-escape pipe character in keycode lists (#7157) 6 жил өмнө
keymap.md 142ebaea46 [Docs] Clarify layer transparency keymap.md (#9081) 6 жил өмнө
mod_tap.md 7e832e46de Add Mac centric Shift and Alt + GUI Macros (#13107) 5 жил өмнө
newbs.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 жил өмнө
newbs_building_firmware.md 54c58ea6de Add explicit id tags to externally linked headers 6 жил өмнө
newbs_building_firmware_configurator.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 жил өмнө
newbs_flashing.md 0f516d9026 A few small typo fixes in docs (#12524) 5 жил өмнө
newbs_getting_started.md 189e0d5b98 Update FreeBSD install method (#12815) 5 жил өмнө
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 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 жил өмнө
newbs_testing_debugging.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 жил өмнө
one_shot_keys.md c00a9937f2 [Docs] Update one_shot_keys.md (#12291) 5 жил өмнө
other_eclipse.md cfbd9ba0e7 eclipse: recommend changing the default project make target (#12447) 5 жил өмнө
other_vscode.md a2af0a352b Update other_vscode.md of Japanese document (#10604) 5 жил өмнө
platformdev_chibios_earlyinit.md 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 жил өмнө
platformdev_selecting_arm_mcu.md 3afd2d81b8 Add documentation for selecting an Arm MCU (#9046) 6 жил өмнө
power.txt bb53635f33 Trim trailing whitespace 8 жил өмнө
pr_checklist.md 268d0efa7e [Docs] pr_checklist: fix capitalization of Vial (#13301) 5 жил өмнө
proton_c_conversion.md 87291437bd Add board specific to Proton-C, with usual defaults turned on. (#10976) 5 жил өмнө
qmk.css ccc87421e7 Some more tweaks to make everything look nice 8 жил өмнө
qmk_custom_dark.css 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 жил өмнө
qmk_custom_light.css 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 жил өмнө
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 bf1c40d682 [Docs] Add EEP_RST keycode to "Wiping the EEPROM" section (#11830) 5 жил өмнө
reference_configurator_support.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 жил өмнө
reference_glossary.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 жил өмнө
reference_info_json.md a0e7333915 Merge remote-tracking branch 'origin/master' into develop 5 жил өмнө
reference_keymap_extras.md e190872b82 Improved Language Specific Keycodes for US International and Extended Layouts (#11307) 5 жил өмнө
serial_driver.md d9610120de Add Full-duplex serial driver for ARM boards (#9842) 5 жил өмнө
spi_driver.md 0e59827023 Merge remote-tracking branch 'upstream/master' into develop 5 жил өмнө
support.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 жил өмнө
sw.js 303f425c6b Fix up info boxes. 8 жил өмнө
syllabus.md 9b70e53508 [Docs] Fixed minor typos (#8860) 6 жил өмнө
tap_hold.md 3559284839 Update IGNORE_MOD_TAP_INTERRUPT (#11452) 5 жил өмнө
translating.md 7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) 6 жил өмнө
uart_driver.md 30b46fad57 UART driver refactor (#11637) 5 жил өмнө
understanding_qmk.md d1806a26e4 Split transport mirror (#11046) 5 жил өмнө
unit_testing.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 жил өмнө
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores 9 жил өмнө
ws2812_driver.md 597d2e0e7b Fix up WS2812 SPI driver on F072. (#13022) 5 жил өмнө

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.