صفحهٔ اصلی گشت‌و‌گذار راهنما
ورود
logic855
/
qmk_firmware
mirrorاز https://github.com/qmk/qmk_firmware.git
1
0
انشعاب 1
پرونده‌ها مشکلات 0 ویکی
درخت: 416dea2c54
شاخه‌ها تگ‌ها
qmk_firmware
/
docs
QMK Bot 416dea2c54 Merge remote-tracking branch 'origin/master' into develop 5 سال پیش
..
ChangeLog c66df16644 2020 November 28 Breaking Changes Update (#11053) 5 سال پیش
de 501f2fdef1 Normalise include statements in core code (#11153) 5 سال پیش
es 501f2fdef1 Normalise include statements in core code (#11153) 5 سال پیش
fr-fr 501f2fdef1 Normalise include statements in core code (#11153) 5 سال پیش
gitbook 4580d3a730 RGB improvements (#1684) 9 سال پیش
he-il e4823aadec Fix capitalisation of "GitHub" (#9184) 6 سال پیش
ja fdfcce57e1 Merge remote-tracking branch 'origin/master' into develop 5 سال پیش
ko-kr cb80b59e93 Adding few Korean translated files (#5895) 5 سال پیش
pt-br e4823aadec Fix capitalisation of "GitHub" (#9184) 6 سال پیش
ru-ru e4823aadec Fix capitalisation of "GitHub" (#9184) 6 سال پیش
zh-cn 501f2fdef1 Normalise include statements in core code (#11153) 5 سال پیش
.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 c66df16644 2020 November 28 Breaking Changes Update (#11053) 5 سال پیش
adc_driver.md 8a4a0c25fd Change analogRead calls to analogReadPin (#9023) 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 c66df16644 2020 November 28 Breaking Changes Update (#11053) 5 سال پیش
breaking_changes_instructions.md fced377ac0 2020 May 30 Breaking Changes Update (#9215) 6 سال پیش
cli.md fcf150bd82 Streamline the macos install process 6 سال پیش
cli_commands.md 37fb14f1b5 CLI-ify rgblight_breathing_table_calc.c (#11174) 5 سال پیش
cli_configuration.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 سال پیش
cli_development.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 سال پیش
coding_conventions_c.md f4b67cde8a Update C coding conventions to match .clang-format config for i… (#8717) 6 سال پیش
coding_conventions_python.md 66d94dc22a Move everything to Python 3.6 (#8835) 6 سال پیش
compatible_microcontrollers.md 7aa4cc9603 adds support for the atmega328 (#9043) 6 سال پیش
config_options.md 501f2fdef1 Normalise include statements in core code (#11153) 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 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 c66df16644 2020 November 28 Breaking Changes Update (#11053) 5 سال پیش
documentation_best_practices.md 995464cb9c [Docs] fix file path (#9540) 6 سال پیش
documentation_templates.md 54c58ea6de Add explicit id tags to externally linked headers 6 سال پیش
driver_installation_zadig.md f0a1ab5488 MSYS and WSL installation improvements (#10593) 5 سال پیش
eeprom_driver.md 70f40339c2 Add i2c 24LC64 eeprom (#11200) 5 سال پیش
faq_build.md 7d5ba88e6f 50-qmk.rules: Move udev rules from documentation into a file (#10664) 5 سال پیش
faq_debug.md 72b1ff5899 Add TMK "FEED" VID to list of deprecated udev rules 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 0cb7133e0d Doc followup 9942 (#10473) 5 سال پیش
feature_audio.md d534c72a54 Added keycodes for swapping and unswapping the Control and OS keys (#6110) 7 سال پیش
feature_auto_shift.md c66df16644 2020 November 28 Breaking Changes Update (#11053) 5 سال پیش
feature_backlight.md c66df16644 2020 November 28 Breaking Changes Update (#11053) 5 سال پیش
feature_bluetooth.md 0fbb1e550a Add description in Bluetooth docs for requiring NKRO to be disabled (#10359) 6 سال پیش
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 4d59657b83 Fix typo within debounce documentation (#10600) 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 c66df16644 2020 November 28 Breaking Changes Update (#11053) 5 سال پیش
feature_grave_esc.md 3510d8dc8d Document an annoyance with Grave Escape and macOS Terminal (#5483) 7 سال پیش
feature_haptic_feedback.md c66df16644 2020 November 28 Breaking Changes Update (#11053) 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 61b64bb82a Redefine IS_LAYER_ON/OFF() as aliases for existing layer functions (#6352) 6 سال پیش
feature_layouts.md 40e67a3074 Add a mechanism for force building a particular community layout (#5027) 7 سال پیش
feature_leader_key.md 294cfd8d33 Delete trailing period in documentation (#9416) 6 سال پیش
feature_led_indicators.md 1ff5ee255f Indicator LEDs as config (#10816) 5 سال پیش
feature_led_matrix.md c66df16644 2020 November 28 Breaking Changes Update (#11053) 5 سال پیش
feature_macros.md 501f2fdef1 Normalise include statements in core code (#11153) 5 سال پیش
feature_mouse_keys.md c66df16644 2020 November 28 Breaking Changes Update (#11053) 5 سال پیش
feature_oled_driver.md c66df16644 2020 November 28 Breaking Changes Update (#11053) 5 سال پیش
feature_pointing_device.md 573d1fbb92 Include `pointing_device_send` in docs (#9185) 6 سال پیش
feature_ps2_mouse.md b7dc2eb9ab Add movement hook to ps2_mouse (#8805) 6 سال پیش
feature_rawhid.md d1df576ece Allow for overriding RAW endpoint usage page and ID. (#8834) 6 سال پیش
feature_rgb_matrix.md c66df16644 2020 November 28 Breaking Changes Update (#11053) 5 سال پیش
feature_rgblight.md 2ef68a84b6 Added color wheel that have QMK HSV values. (#8997) 5 سال پیش
feature_sequencer.md c66df16644 2020 November 28 Breaking Changes Update (#11053) 5 سال پیش
feature_space_cadet.md d16db69367 Added mod carry over from press to release. (#5866) 7 سال پیش
feature_split_keyboard.md 16d55b14b7 [Docs] Add VBUS hack for teensys (#10986) 5 سال پیش
feature_stenography.md 64603ab647 fix typo (#9695) 6 سال پیش
feature_swap_hands.md 805f5cb72b One shot support for swap hands (#8590) 6 سال پیش
feature_tap_dance.md 9d3b26a475 Update features to use Custom Tapping Term when appropriate (#6259) 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 02781979d6 [Docs] Improve Unicode documentation (#8676) 6 سال پیش
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 bfb2f8e0a8 Add Word Per Minute calculation feature (#8054) 6 سال پیش
flashing.md d00ac5dfb6 Add `st-flash` flash target (#9964) 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_docker.md 0fbcb41c85 Reintegrate previous docker docs (#9084) 6 سال پیش
getting_started_github.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 سال پیش
getting_started_introduction.md 09c7304bd9 [Docs] update git command and directory name of documents (#7619) 6 سال پیش
getting_started_make_guide.md 0f596881b3 Remove support for Adafruit EZ-Key (#10103) 6 سال پیش
getting_started_vagrant.md bc13dcd349 Remove Atmel FLIP from install scripts and documentation (#8822) 6 سال پیش
hand_wire.md 961477c791 make sure all our redirects are in order 6 سال پیش
hardware_avr.md 72d3270547 Remove `DESCRIPTION` (#9732) 6 سال پیش
hardware_drivers.md d13ada1162 Add customisable EEPROM driver selection (#7274) 6 سال پیش
hardware_keyboard_guidelines.md 4d33d72975 New command: qmk lint (#10761) 5 سال پیش
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 346bfb2a05 Update i2c_driver.md (#10131) 6 سال پیش
index.html 489bee0ee4 [Docs] redirect from /tutorial to /newbs (#10718) 5 سال پیش
internals_defines.md ae7284edb8 rename api docs to internals 8 سال پیش
internals_gpio_control.md c66df16644 2020 November 28 Breaking Changes Update (#11053) 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 c4d778a302 [Docs] Update ISP Guide (#9748) 6 سال پیش
keycodes.md b4ae7badd4 Issue 9942: Add LSA, RSA, RCS, LSA_T, RSA_T, and RCS_T (#9943) 6 سال پیش
keycodes_basic.md 370577e4ed Add *OPT aliases for *ALT keycodes and macros (#8714) 6 سال پیش
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 139d28eaae [Docs] Add link to Tap-Hold Configuration Options from Mod-Tap (#10548) 5 سال پیش
newbs.md 489bee0ee4 [Docs] redirect from /tutorial to /newbs (#10718) 5 سال پیش
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 9c8f61dfa0 [Docs] newbs_flashing.md: place bootloader instructions before Toolbox intro (#9077) 6 سال پیش
newbs_getting_started.md c21d5a0973 Refactor qmk_install.sh (#10681) 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 45e218ceec overhaul the newbs guide 6 سال پیش
newbs_testing_debugging.md 501f2fdef1 Normalise include statements in core code (#11153) 5 سال پیش
one_shot_keys.md 078586b21a Update one_shot_keys.md (#10917) 5 سال پیش
other_eclipse.md cde5237a88 fix two links on docs/other_eclipse.md (#8417) 6 سال پیش
other_vscode.md a2af0a352b Update other_vscode.md of Japanese document (#10604) 5 سال پیش
platformdev_chibios_earlyinit.md 93e7a8f74c Add dual-bank STM32 bootloader support, given GPIO toggle on BOOT0 to charge RC circuit. (#8778) 6 سال پیش
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 94e94ffb5b Recommend use of LED Indicator config (#10895) 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 1b267d4840 Fix darkmode (#8393) 6 سال پیش
qmk_custom_light.css 1b267d4840 Fix darkmode (#8393) 6 سال پیش
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 2f637e4ea1 [Docs] Clarify functionality of update_tri_layer_state (#10370) 6 سال پیش
reference_configurator_support.md d5f34c4810 Polish Configurator section 6 سال پیش
reference_glossary.md 29ebb99b1f fixed link to Eclipse instructions (#9647) 6 سال پیش
reference_info_json.md 9e9b604234 Mark 'key_count' as optional within info.json docs (#10513) 5 سال پیش
reference_keymap_extras.md 5f9fb01020 [Keymap Extra] Add French AZERTY (AFNOR - NF Z71-300) (#9644) 6 سال پیش
serial_driver.md 990d5189d1 Configurable serial usart timeout (#11057) 5 سال پیش
spi_driver.md 7aa4cc9603 adds support for the atmega328 (#9043) 6 سال پیش
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 c66df16644 2020 November 28 Breaking Changes Update (#11053) 5 سال پیش
translating.md 7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) 6 سال پیش
understanding_qmk.md 5117dff6a2 Add Post Processing to process_record (#4892) 6 سال پیش
unit_testing.md e02a3c559d Edit Unit Testing Documentation (#8961) 6 سال پیش
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores 9 سال پیش
ws2812_driver.md c59f87a5d7 add definition WS2812_BYTE_ORDER to fix RGB LED issues (#10184) 5 سال پیش

README.md

Quantum Mechanical Keyboard Firmware

Current Version Build Status Discord Docs Status GitHub contributors GitHub forks

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:

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.