صفحهٔ اصلی گشت‌و‌گذار راهنما
ورود
logic855
/
qmk_firmware
mirrorاز https://github.com/qmk/qmk_firmware.git
1
0
انشعاب 1
پرونده‌ها مشکلات 0 ویکی
شاخه: make_cli_parsing
شاخه‌ها تگ‌ها
qmk_firmware
/
docs
umi d0c3a4c8d5 [Docs] Japanese translation of docs/feature_encoders.md (#8843) 6 سال پیش
..
ChangeLog 26eef35f07 2020 February 29 Breaking Changes Update (#8064) 6 سال پیش
de 400ca2d035 spi_master for AVR (#8299) 6 سال پیش
es 400ca2d035 spi_master for AVR (#8299) 6 سال پیش
fr-fr bc13dcd349 Remove Atmel FLIP from install scripts and documentation (#8822) 6 سال پیش
gitbook 4580d3a730 RGB improvements (#1684) 9 سال پیش
he-il 400ca2d035 spi_master for AVR (#8299) 6 سال پیش
ja d0c3a4c8d5 [Docs] Japanese translation of docs/feature_encoders.md (#8843) 6 سال پیش
pt-br 400ca2d035 spi_master for AVR (#8299) 6 سال پیش
ru-ru 400ca2d035 spi_master for AVR (#8299) 6 سال پیش
zh-cn bc13dcd349 Remove Atmel FLIP from install scripts and documentation (#8822) 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 8c97b4a3a4 Add a syllabus to guide people who are learning QMK (#8816) 6 سال پیش
adc_driver.md 567bfc97ac ARM - ADC cleanup (#8385) 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 66d94dc22a Move everything to Python 3.6 (#8835) 6 سال پیش
cli_commands.md 21799be1ca Make dedicated sections for user/dev commands in docs 6 سال پیش
cli_configuration.md dc68418660 Fix some broken links in the docs (#8394) 6 سال پیش
cli_development.md 66d94dc22a Move everything to Python 3.6 (#8835) 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 5414ff709f [Doc] Tidy up compatible MCUs docs (#7295) 6 سال پیش
config_options.md be2f5816b6 Fix compile issues related to NO_ACTION_MACRO/FUNCTION and LTO_ENABLE (#8663) 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) 7 سال پیش
eeprom_driver.md f2f2afe13b Add support for STM32L0/L1 onboard EEPROM. (#8002) 6 سال پیش
faq_build.md a52e55ec09 [Docs] Update macOS related issues in docs (#7744) 6 سال پیش
faq_debug.md bc13dcd349 Remove Atmel FLIP from install scripts and documentation (#8822) 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 370577e4ed Add *OPT aliases for *ALT keycodes and macros (#8714) 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 789e199450 Add support for Bootmagic lite when using SPLIT_HAND_PIN (#8347) 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 b8c3f4c60b quantum/debounce: Added sym_pk debounce algorithm (#8587) 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) 7 سال پیش
feature_key_lock.md 54c58ea6de Add explicit id tags to externally linked headers 6 سال پیش
feature_layers.md 5df2424651 [Docs] Update layer documentation (#8371) 6 سال پیش
feature_layouts.md 40e67a3074 Add a mechanism for force building a particular community layout (#5027) 7 سال پیش
feature_leader_key.md 5df2424651 [Docs] Update layer documentation (#8371) 6 سال پیش
feature_led_matrix.md 24df54b807 Add documentation for led matrix 7 سال پیش
feature_macros.md 370577e4ed Add *OPT aliases for *ALT keycodes and macros (#8714) 6 سال پیش
feature_mouse_keys.md 3cd2a27ac0 Decouple mouse cursor and mouse wheel in accelerated mode (#6685) 6 سال پیش
feature_oled_driver.md b5be96f8bb Adding OLED scroll setup functions (#8386) 6 سال پیش
feature_pointing_device.md b272c035ba [Docs] Random Fixes (#8340) 6 سال پیش
feature_ps2_mouse.md 07c75feba3 Add PS2_MOUSE_ROTATE to compensate for device orientation (#8650) 6 سال پیش
feature_rgb_matrix.md 5075a1d9e4 [Docs] Update RGB Matrix docs with function refs (#8367) 6 سال پیش
feature_rgblight.md a521fc2b6c [Docs] Fixes for feature_rgblight.md (#8514) 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 b272c035ba [Docs] Random Fixes (#8340) 6 سال پیش
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) 7 سال پیش
feature_thermal_printer.md 4c675a83ba Format keycode tables 8 سال پیش
feature_unicode.md bdfdc506da Rename UC_OSX (and related constants) to UC_MAC (#8589) 6 سال پیش
feature_userspace.md 19dbcf3814 Document 'make all:<name>' (#8439) 6 سال پیش
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 bc13dcd349 Remove Atmel FLIP from install scripts and documentation (#8822) 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_github.md 9046107183 Restore getting_started_github.md doc 6 سال پیش
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 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 f87908228a Remove apostrophe from various abbreviations' plural forms (#7050) 7 سال پیش
hardware_drivers.md d13ada1162 Add customisable EEPROM driver selection (#7274) 6 سال پیش
hardware_keyboard_guidelines.md dc98d44582 [Docs] added the description of the reading order of the rules.mk files. (#8566) 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 b272c035ba [Docs] Random Fixes (#8340) 6 سال پیش
index.html dc68418660 Fix some broken links in the docs (#8394) 6 سال پیش
internals_defines.md ae7284edb8 rename api docs to internals 8 سال پیش
internals_gpio_control.md b272c035ba [Docs] Random Fixes (#8340) 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 370577e4ed Add *OPT aliases for *ALT keycodes and macros (#8714) 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 54c58ea6de Add explicit id tags to externally linked headers 6 سال پیش
mod_tap.md 370577e4ed Add *OPT aliases for *ALT keycodes and macros (#8714) 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 3cea9fedff Add missing repository name to qmk setup w/ github (#8792) 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 cde5237a88 fix two links on docs/other_eclipse.md (#8417) 6 سال پیش
other_vscode.md e9ace14878 [Docs] Add VSCode guide to docs (#5124) 7 سال پیش
platformdev_chibios_earlyinit.md 05e9ff6554 Add support for hardware and board initialisation overrides. (#8330) 6 سال پیش
power.txt bb53635f33 Trim trailing whitespace 8 سال پیش
proton_c_conversion.md 7918f7d61d Document the Proton C pins for manual Pro Micro conversion (#7043) 6 سال پیش
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 750179e111 Fix a couple of typos that were causing confusion (#8767) 6 سال پیش
reference_configurator_support.md d5f34c4810 Polish Configurator section 6 سال پیش
reference_glossary.md bc13dcd349 Remove Atmel FLIP from install scripts and documentation (#8822) 6 سال پیش
reference_info_json.md bcb1815420 Add label to the info.json reference 7 سال پیش
spi_driver.md 46e4493761 Fix AVR SPI parameter configuration, remove timeouts due to sync protocol. (#8775) 6 سال پیش
support.md 961477c791 make sure all our redirects are in order 6 سال پیش
sw.js 303f425c6b Fix up info boxes. 8 سال پیش
syllabus.md 9b70e53508 [Docs] Fixed minor typos (#8860) 6 سال پیش
tap_hold.md 9b70e53508 [Docs] Fixed minor typos (#8860) 6 سال پیش
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 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 سال پیش

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.