Начало Каталог Помощ
Регистрация Вход
HuiJun
/
qmk_firmware
1
0
Разклонения 0
Файлове Задачи 0 Заявки за сливане 0 Уики
ИН на ревизия: 2fe7e221ec
Клонове Маркери
qmk_firmware
/
docs
Joshua Diamond 2fe7e221ec New RGB Lighting effect: Twinkle (#8887) преди 5 години
..
ChangeLog 26eef35f07 2020 February 29 Breaking Changes Update (#8064) преди 5 години
de 400ca2d035 spi_master for AVR (#8299) преди 5 години
es 400ca2d035 spi_master for AVR (#8299) преди 5 години
fr-fr bc13dcd349 Remove Atmel FLIP from install scripts and documentation (#8822) преди 5 години
gitbook 4580d3a730 RGB improvements (#1684) преди 7 години
he-il 400ca2d035 spi_master for AVR (#8299) преди 5 години
ja 830bd5460c [Docs] Japanese translation of docs/feature_key_lock.md (#8948) преди 5 години
pt-br 400ca2d035 spi_master for AVR (#8299) преди 5 години
ru-ru 400ca2d035 spi_master for AVR (#8299) преди 5 години
zh-cn bc13dcd349 Remove Atmel FLIP from install scripts and documentation (#8822) преди 5 години
.nojekyll 9e5676650e Use docsfy to replace gitbook преди 7 години
CNAME 4d26137e2a Create CNAME преди 7 години
README.md 961477c791 make sure all our redirects are in order преди 5 години
_langs.md 10e8ed7430 [Docs] add README translation in portuguese (#7016) преди 5 години
_summary.md 750c7c2bdb [Documentation] Added raw hid documentation page (#7640) преди 5 години
adc_driver.md 567bfc97ac ARM - ADC cleanup (#8385) преди 5 години
api_development_environment.md 99850aabca Add API documentation преди 5 години
api_development_overview.md 99850aabca Add API documentation преди 5 години
api_docs.md 99850aabca Add API documentation преди 5 години
api_overview.md 99850aabca Add API documentation преди 5 години
arm_debugging.md 52c18ef026 [Docs] fix docs (#7642) преди 5 години
breaking_changes.md f513a9193c Fix the Breaking Changes doc again преди 5 години
breaking_changes_instructions.md 72d7661b30 suggestions by skullydazed преди 5 години
cli.md 66d94dc22a Move everything to Python 3.6 (#8835) преди 5 години
cli_commands.md 21799be1ca Make dedicated sections for user/dev commands in docs преди 5 години
cli_configuration.md dc68418660 Fix some broken links in the docs (#8394) преди 5 години
cli_development.md 66d94dc22a Move everything to Python 3.6 (#8835) преди 5 години
coding_conventions_c.md f4b67cde8a Update C coding conventions to match .clang-format config for i… (#8717) преди 5 години
coding_conventions_python.md 66d94dc22a Move everything to Python 3.6 (#8835) преди 5 години
compatible_microcontrollers.md 5414ff709f [Doc] Tidy up compatible MCUs docs (#7295) преди 5 години
config_options.md e0f548085c Add ability to blink lighting layer for a specified duration (#8760) преди 5 години
configurator_step_by_step.md d5f34c4810 Polish Configurator section преди 5 години
configurator_troubleshooting.md d5f34c4810 Polish Configurator section преди 5 години
contributing.md 54c58ea6de Add explicit id tags to externally linked headers преди 5 години
custom_matrix.md 6e710426a4 Add docs for 'CUSTOM_MATRIX = lite' (#7906) преди 5 години
custom_quantum_functions.md 54c58ea6de Add explicit id tags to externally linked headers преди 5 години
documentation_best_practices.md 303f425c6b Fix up info boxes. преди 7 години
documentation_templates.md 54c58ea6de Add explicit id tags to externally linked headers преди 5 години
driver_installation_zadig.md 80ded60cad Add a short explanation to Zadig the troubleshooting section (#7110) преди 5 години
eeprom_driver.md f2f2afe13b Add support for STM32L0/L1 onboard EEPROM. (#8002) преди 5 години
faq_build.md a52e55ec09 [Docs] Update macOS related issues in docs (#7744) преди 5 години
faq_debug.md bc13dcd349 Remove Atmel FLIP from install scripts and documentation (#8822) преди 5 години
faq_general.md a701c15d87 Rework the newbs guide around the qmk cli преди 5 години
faq_keymap.md 12e43230c6 make custom_keycode_names.md a faq entry instead преди 5 години
feature_advanced_keycodes.md 370577e4ed Add *OPT aliases for *ALT keycodes and macros (#8714) преди 5 години
feature_audio.md d534c72a54 Added keycodes for swapping and unswapping the Control and OS keys (#6110) преди 5 години
feature_auto_shift.md e9c44e396d Smallish overhaul of Auto-Shift feature (#6067) преди 5 години
feature_backlight.md 54c58ea6de Add explicit id tags to externally linked headers преди 5 години
feature_bluetooth.md 908aede957 Update feature_bluetooth.md (#7193) преди 5 години
feature_bootmagic.md 789e199450 Add support for Bootmagic lite when using SPLIT_HAND_PIN (#8347) преди 5 години
feature_combo.md 57540af102 Change "yu" to "you" in combo docs (#6510) преди 5 години
feature_command.md a2e91ebec9 Update IS_COMMAND definitions to use MOD_MASK_SHIFT (#6348) преди 5 години
feature_debounce_type.md b8c3f4c60b quantum/debounce: Added sym_pk debounce algorithm (#8587) преди 5 години
feature_dip_switch.md dab4967f1b Add Dip Switch as a core feature (#6140) преди 5 години
feature_dynamic_macros.md 542cb0a8ce [Core] Convert Dynamic Macro to a Core Feature (#5948) преди 5 години
feature_encoders.md bafa35ff46 fix sample code indent in feature_encoders.md (#8883) преди 5 години
feature_grave_esc.md 3510d8dc8d Document an annoyance with Grave Escape and macOS Terminal (#5483) преди 6 години
feature_haptic_feedback.md f275ffbdfc Minor grammar and filename fixes in docs (#7559) преди 5 години
feature_hd44780.md b23f6011c3 Remove build option firmware size impacts (#6947) преди 5 години
feature_key_lock.md 54c58ea6de Add explicit id tags to externally linked headers преди 5 години
feature_layers.md 5df2424651 [Docs] Update layer documentation (#8371) преди 5 години
feature_layouts.md 40e67a3074 Add a mechanism for force building a particular community layout (#5027) преди 6 години
feature_leader_key.md 5df2424651 [Docs] Update layer documentation (#8371) преди 5 години
feature_led_matrix.md 24df54b807 Add documentation for led matrix преди 6 години
feature_macros.md 370577e4ed Add *OPT aliases for *ALT keycodes and macros (#8714) преди 5 години
feature_mouse_keys.md 3cd2a27ac0 Decouple mouse cursor and mouse wheel in accelerated mode (#6685) преди 5 години
feature_oled_driver.md b5be96f8bb Adding OLED scroll setup functions (#8386) преди 5 години
feature_pointing_device.md b272c035ba [Docs] Random Fixes (#8340) преди 5 години
feature_ps2_mouse.md 07c75feba3 Add PS2_MOUSE_ROTATE to compensate for device orientation (#8650) преди 5 години
feature_rawhid.md 750c7c2bdb [Documentation] Added raw hid documentation page (#7640) преди 5 години
feature_rgb_matrix.md 5075a1d9e4 [Docs] Update RGB Matrix docs with function refs (#8367) преди 5 години
feature_rgblight.md 2fe7e221ec New RGB Lighting effect: Twinkle (#8887) преди 5 години
feature_space_cadet.md d16db69367 Added mod carry over from press to release. (#5866) преди 6 години
feature_split_keyboard.md 307be48de9 Reduce SPLIT_USB_TIMEOUT by 500ms (#7637) преди 5 години
feature_stenography.md b272c035ba [Docs] Random Fixes (#8340) преди 5 години
feature_swap_hands.md fd085837e1 fix swap_hands keycodes in documentation (#3588) преди 6 години
feature_tap_dance.md 54c58ea6de Add explicit id tags to externally linked headers преди 5 години
feature_terminal.md b23f6011c3 Remove build option firmware size impacts (#6947) преди 5 години
feature_thermal_printer.md 4c675a83ba Format keycode tables преди 7 години
feature_unicode.md bdfdc506da Rename UC_OSX (and related constants) to UC_MAC (#8589) преди 5 години
feature_userspace.md 19dbcf3814 Document 'make all:<name>' (#8439) преди 5 години
feature_velocikey.md c1c5922aae Velocikey: Match RGB animation speed to typing speed (#3754) преди 6 години
feature_wpm.md bfb2f8e0a8 Add Word Per Minute calculation feature (#8054) преди 5 години
flashing.md bc13dcd349 Remove Atmel FLIP from install scripts and documentation (#8822) преди 5 години
flashing_bootloadhid.md 235da6973d Install bootloadHid as part of qmk_install (#7463) преди 5 години
fuse.txt ca01d94005 convert docs to lowercase and underscores преди 8 години
getting_started_github.md 9046107183 Restore getting_started_github.md doc преди 5 години
getting_started_introduction.md 09c7304bd9 [Docs] update git command and directory name of documents (#7619) преди 5 години
getting_started_make_guide.md 6e710426a4 Add docs for 'CUSTOM_MATRIX = lite' (#7906) преди 5 години
getting_started_vagrant.md bc13dcd349 Remove Atmel FLIP from install scripts and documentation (#8822) преди 5 години
hand_wire.md 961477c791 make sure all our redirects are in order преди 5 години
hardware_avr.md f87908228a Remove apostrophe from various abbreviations' plural forms (#7050) преди 5 години
hardware_drivers.md d13ada1162 Add customisable EEPROM driver selection (#7274) преди 5 години
hardware_keyboard_guidelines.md dc98d44582 [Docs] added the description of the reading order of the rules.mk files. (#8566) преди 5 години
how_a_matrix_works.md a95a314f78 refactor How a Matrix Works doc преди 5 години
how_keyboards_work.md d5316e9714 Update URL for `60-keyboard.hwdb` (#7185) преди 5 години
i2c_driver.md b272c035ba [Docs] Random Fixes (#8340) преди 5 години
index.html e182a38e7c Add redirect for old getting started links (#8987) преди 5 години
internals_defines.md ae7284edb8 rename api docs to internals преди 7 години
internals_gpio_control.md d26a14c169 add 'togglePin' convenience function (#8734) преди 5 години
internals_input_callback_reg.md ae7284edb8 rename api docs to internals преди 7 години
internals_midi_device.md ae7284edb8 rename api docs to internals преди 7 години
internals_midi_device_setup_process.md ae7284edb8 rename api docs to internals преди 7 години
internals_midi_util.md ae7284edb8 rename api docs to internals преди 7 години
internals_send_functions.md ae7284edb8 rename api docs to internals преди 7 години
internals_sysex_tools.md ae7284edb8 rename api docs to internals преди 7 години
isp_flashing_guide.md abd36de5ad [Docs] Update ISP Flashing guide (#8149) преди 5 години
keycodes.md 370577e4ed Add *OPT aliases for *ALT keycodes and macros (#8714) преди 5 години
keycodes_basic.md 370577e4ed Add *OPT aliases for *ALT keycodes and macros (#8714) преди 5 години
keycodes_us_ansi_shifted.md 40de65eac4 Backslash-escape pipe character in keycode lists (#7157) преди 5 години
keymap.md 54c58ea6de Add explicit id tags to externally linked headers преди 5 години
mod_tap.md 370577e4ed Add *OPT aliases for *ALT keycodes and macros (#8714) преди 5 години
newbs.md 45e218ceec overhaul the newbs guide преди 5 години
newbs_building_firmware.md 54c58ea6de Add explicit id tags to externally linked headers преди 5 години
newbs_building_firmware_configurator.md d5f34c4810 Polish Configurator section преди 5 години
newbs_flashing.md 54c58ea6de Add explicit id tags to externally linked headers преди 5 години
newbs_getting_started.md 2c0deb8a13 Update and try to clarify the CLI installation on Linux (#8783) преди 5 години
newbs_git_best_practices.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) преди 5 години
newbs_git_resolving_merge_conflicts.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) преди 5 години
newbs_git_resynchronize_a_branch.md 26a823082b [Docs] Fix minor differences in docs/newbs_git_resynchronize_a_branch.md (#7728) преди 5 години
newbs_git_using_your_master_branch.md 54c58ea6de Add explicit id tags to externally linked headers преди 5 години
newbs_learn_more_resources.md 45e218ceec overhaul the newbs guide преди 5 години
newbs_testing_debugging.md 54c58ea6de Add explicit id tags to externally linked headers преди 5 години
one_shot_keys.md 9035c3497e break feature_advanced_keycodes.md up into multiple files преди 5 години
other_eclipse.md cde5237a88 fix two links on docs/other_eclipse.md (#8417) преди 5 години
other_vscode.md e9ace14878 [Docs] Add VSCode guide to docs (#5124) преди 6 години
platformdev_chibios_earlyinit.md 05e9ff6554 Add support for hardware and board initialisation overrides. (#8330) преди 5 години
power.txt bb53635f33 Trim trailing whitespace преди 7 години
proton_c_conversion.md 7918f7d61d Document the Proton C pins for manual Pro Micro conversion (#7043) преди 5 години
qmk.css ccc87421e7 Some more tweaks to make everything look nice преди 7 години
qmk_custom_dark.css 1b267d4840 Fix darkmode (#8393) преди 5 години
qmk_custom_light.css 1b267d4840 Fix darkmode (#8393) преди 5 години
quantum_keycodes.md 54c58ea6de Add explicit id tags to externally linked headers преди 5 години
redirects.json d569f08771 Configuration system for CLI (#6708) преди 5 години
ref_functions.md 750179e111 Fix a couple of typos that were causing confusion (#8767) преди 5 години
reference_configurator_support.md d5f34c4810 Polish Configurator section преди 5 години
reference_glossary.md bc13dcd349 Remove Atmel FLIP from install scripts and documentation (#8822) преди 5 години
reference_info_json.md bcb1815420 Add label to the info.json reference преди 6 години
spi_driver.md b17482c3fd Add SPI master for ChibiOS/ARM. (#8779) преди 5 години
support.md 961477c791 make sure all our redirects are in order преди 5 години
sw.js 303f425c6b Fix up info boxes. преди 7 години
syllabus.md 9b70e53508 [Docs] Fixed minor typos (#8860) преди 5 години
tap_hold.md 9b70e53508 [Docs] Fixed minor typos (#8860) преди 5 години
translating.md 7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) преди 5 години
understanding_qmk.md 5117dff6a2 Add Post Processing to process_record (#4892) преди 5 години
unit_testing.md e02a3c559d Edit Unit Testing Documentation (#8961) преди 5 години
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores преди 8 години
ws2812_driver.md f74c769a19 PWM DMA based RGB Underglow for STM32 (#7928) преди 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.