Почетна Преглед Помоћ
Пријавите се
logic855
/
qmk_firmware
огледало од https://github.com/qmk/qmk_firmware.git
1
0
Креирај огранак 1
Датотеке Дискусије 0 Вики
Дрво: d026803147
Гране Ознаке
qmk_firmware
/
docs
Nick Brassel 1b3f7fcf7d Add `qmk find` command, reuse logic for `qmk mass-compile`. (#20139) пре 3 година
..
ChangeLog b865b9e170 Add changelog for Leader Key refactor (#19953) пре 3 година
gitbook 4580d3a730 RGB improvements (#1684) пре 9 година
internals 75544d9127 Move Doxygen docs to subdirectory (#16561) пре 4 година
ja 12f02dd8be [Doc]Remove depracted extension links in vscode guide (#19842) пре 3 година
zh-cn 12f02dd8be [Doc]Remove depracted extension links in vscode guide (#19842) пре 3 година
.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 1c1e6fa47d Remove stale docs translations (#15737) пре 4 година
_summary.md f5ccd04a5f Stub changelog пре 3 година
adc_driver.md 272281f1a0 Add analog support for RP2040 (#19453) пре 3 година
api_development_environment.md 99850aabca Add API documentation пре 6 година
api_development_overview.md 99850aabca Add API documentation пре 6 година
api_docs.md 9e78e65a56 2022 Nov 26 changelog. (#19164) пре 3 година
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 19145704e4 [Core] Adjust PWM hardware audio driver for RP2040 (#17723) пре 3 година
breaking_changes.md 7ebb8c2dec Update branch names to reflect configurator's new deployment. (#19999) пре 3 година
breaking_changes_history.md f5ccd04a5f Stub changelog пре 3 година
breaking_changes_instructions.md fced377ac0 2020 May 30 Breaking Changes Update (#9215) пре 6 година
chibios_upgrade_instructions.md 7ebb8c2dec Update branch names to reflect configurator's new deployment. (#19999) пре 3 година
cli.md fcf150bd82 Streamline the macos install process пре 6 година
cli_commands.md 1b3f7fcf7d Add `qmk find` command, reuse logic for `qmk mass-compile`. (#20139) пре 3 година
cli_configuration.md e4823aadec Fix capitalisation of "GitHub" (#9184) пре 6 година
cli_development.md 959f4cbb62 docs: some typos (#18582) пре 3 година
cli_tab_complete.md ee26d3e77f Add Zsh note for tab complete (#17226) пре 4 година
coding_conventions_c.md 959f4cbb62 docs: some typos (#18582) пре 3 година
coding_conventions_python.md 959f4cbb62 docs: some typos (#18582) пре 3 година
compatible_microcontrollers.md ac5e6b6a3b Tentative Teensy 3.5 support (#14420) пре 4 година
config_options.md b47f179a4a Make Magic handling more consistent in Action Keycode handling (#9126) пре 3 година
configurator_architecture.md 9a0118c603 Architecture documentation for Configurator and API (#13935) пре 5 година
configurator_default_keymaps.md 961f0b7b2d Reallocate SAFE_RANGE (#19909) пре 3 година
configurator_diagram.drawio 9a0118c603 Architecture documentation for Configurator and API (#13935) пре 5 година
configurator_diagram.svg 9a0118c603 Architecture documentation for Configurator and API (#13935) пре 5 година
configurator_step_by_step.md f6a7f4d4ac update the Chinese translation based on the latest English version (#14924) пре 4 година
configurator_troubleshooting.md d5f34c4810 Polish Configurator section пре 6 година
contributing.md 22be5190ab Minor cleanup to breaking/checklist docs. (#19596) пре 3 година
custom_matrix.md 11d49d00e7 Remove matrix_init_quantum/matrix_scan_quantum (#19806) пре 3 година
custom_quantum_functions.md 012fa6dd45 [Doc] Add example to keyboard housekeeping and some minor fixes (#19968) пре 3 година
data_driven_config.md 479d8de622 Format DD mappings and schemas (#18924) пре 3 година
documentation_best_practices.md 995464cb9c [Docs] fix file path (#9540) пре 6 година
documentation_templates.md b756c53c7b [Docs] Touch up documentation templates & porting keyboard docs (#19573) пре 3 година
driver_installation_zadig.md 01f31bf28e [Docs] RESET -> QK_BOOT (#18365) пре 3 година
easy_maker.md f6a7f4d4ac update the Chinese translation based on the latest English version (#14924) пре 4 година
eeprom_driver.md 5846b40f74 RP2040 emulated EEPROM. (#17519) пре 4 година
faq_build.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) пре 5 година
faq_debug.md 18dc851e37 Remove legacy Debug keycode (#18769) пре 3 година
faq_general.md d6701b3ac7 Fix typos and reword some sentences in FAQs (#11546) пре 5 година
faq_keymap.md d241e80533 Keymap FAQ updates (#17130) пре 4 година
faq_misc.md 01f31bf28e [Docs] RESET -> QK_BOOT (#18365) пре 3 година
feature_advanced_keycodes.md 012fa6dd45 [Doc] Add example to keyboard housekeeping and some minor fixes (#19968) пре 3 година
feature_audio.md 69fa02c37d Align audio keycode names (#18962) пре 3 година
feature_auto_shift.md 515dd18c28 Remove IGNORE_MOD_TAP_INTERRUPT_PER_KEY in favour of HOLD_ON_OTHER_KEY_PRESS_PER_KEY (#15741) пре 3 година
feature_autocorrect.md a71e58270c Document Autocorrect callback functions (#20115) пре 3 година
feature_backlight.md 219afaba42 Reworked backlight keycodes. (#18961) пре 3 година
feature_bluetooth.md d810878d5e Normalise output selection (Bluetooth) keycodes (#19004) пре 3 година
feature_bootmagic.md 9aaf4a5a9b Add split keyboard example for Bootmagic Lite (#16349) пре 4 година
feature_caps_word.md a80b886751 Deprecate `CAPS_WORD`/`CAPSWRD` for `CW_TOGG` (#18834) пре 3 година
feature_combo.md ec3c2b75de [Docs] Add mod-tap section header (#20041) пре 3 година
feature_command.md a03aa301de Remove Full Bootmagic (#13846) пре 5 година
feature_converters.md 896d9aa98c Add rp2040_ce and add elite-pi and helios as alias (#19830) пре 3 година
feature_debounce_type.md 25713dc222 Add sym_defer_pr debouncer type (#14948) пре 4 година
feature_digitizer.md 6cc9513ab0 Digitizer feature improvements (#19034) пре 3 година
feature_dip_switch.md 9d1c98c891 Added right vs left specific pin assignments for dip switch (#13074) пре 5 година
feature_dynamic_macros.md fe18df9d41 Normalise Dynamic Macro keycodes (#18939) пре 3 година
feature_eeprom.md 7407347be1 Remove rgblight_list.h (#18878) пре 3 година
feature_encoders.md 9cf58ec834 Elaborate on keyboard level encoder functionality (#19839) пре 3 година
feature_grave_esc.md b45a037c7e Rename some Quantum keycodes (#15968) пре 4 година
feature_haptic_feedback.md e4d2ba9a4d Align haptic feedback keycode names (#18964) пре 3 година
feature_hd44780.md 9ee2effe8e HD44780 driver rework (#16370) пре 4 година
feature_joystick.md 917d93e968 [Docs] Fix `JOYSTICK_AXIS_COUNT` name in docs (#19605) пре 3 година
feature_key_lock.md eeb3f9c043 Merge remote-tracking branch 'origin/master' into develop пре 3 година
feature_key_overrides.md 012fa6dd45 [Doc] Add example to keyboard housekeeping and some minor fixes (#19968) пре 3 година
feature_layers.md 21f4375393 Update documentation for LM(layer, mod) (#19284) пре 3 година
feature_layouts.md b56282756b [Docs] Clean up some code block languages (#14434) пре 5 година
feature_leader_key.md bbf7a20b33 Refactor Leader key feature (#19632) пре 3 година
feature_led_indicators.md 1124bbc1db Remove deprecated led_set_kb (#19273) пре 3 година
feature_led_matrix.md b56ffc8920 docs: Fix IS31FL3743A driver name (#19518) пре 3 година
feature_macros.md 4d33f356a6 Macro keycode name refactoring (#18958) пре 3 година
feature_midi.md 650864c27d Merge remote-tracking branch 'origin/master' into develop пре 3 година
feature_mouse_keys.md 2a61bfc27d add "inertia" mode for mouse keys (#18774) пре 3 година
feature_oled_driver.md a5c2eea6c1 Update OLED doc (#19213) пре 3 година
feature_os_detection.md 85ee55ff3b Detect host OS based on USB fingerprint (#18463) пре 3 година
feature_pointing_device.md d9cba6e978 Add `*_RIGHT` configuration for PMW33XX driver (#19243) пре 3 година
feature_programmable_button.md 6bbe8b6edd Normalise Joystick and Programmable Button keycodes (#18832) пре 3 година
feature_ps2_mouse.md 0237ff0c62 [Core] Rework PS/2 driver selection (#17892) пре 4 година
feature_rawhid.md b56282756b [Docs] Clean up some code block languages (#14434) пре 5 година
feature_rgb_matrix.md 204ba02765 Use consistent highlight format (#19619) пре 3 година
feature_rgblight.md 11ae141835 Fix description for selectively disabling animations (#19374) пре 3 година
feature_secure.md ec2414c074 Deprecate `SECURE_*` keycodes for `QK_SECURE_*` (#18847) пре 3 година
feature_send_string.md 3ecb0a80af Feature-ify Send String (#17275) пре 4 година
feature_sequencer.md f587a0c548 Align sequencer keycodes (#19875) пре 3 година
feature_space_cadet.md 002b58f0e4 Normalise Space Cadet keycodes (#18864) пре 3 година
feature_split_keyboard.md f067f42305 [Docs] Discuss layout macro (#19803) пре 3 година
feature_st7565.md 37fba09021 ST7565 invert (#13237) пре 5 година
feature_stenography.md 95c1cc425e Rename postprocess_steno_user → post_process_steno_user (#17823) пре 4 година
feature_swap_hands.md 9908ed7ecd Add swap hands status function (#19831) пре 3 година
feature_tap_dance.md 1978007fae Tap Dance: remove `qk_` prefix (#19313) пре 3 година
feature_tri_layer.md fe02abc479 [Core] Tri Layer Keys (#19795) пре 3 година
feature_unicode.md ea96799970 Merge remote-tracking branch 'origin/master' into develop пре 3 година
feature_userspace.md 40bc5a8192 Enable CLI flashing via mdloader (#14729) пре 4 година
feature_velocikey.md 74484e21af Deprecate `VLK_TOG` for `VK_TOGG` (#18807) пре 3 година
feature_wpm.md 0391801267 Fixes potential wpm sampling overflow, along with code comment fixes (#15277) пре 4 година
flash_driver.md 71c0b97bce Added external spi flash driver. (#15419) пре 4 година
flashing.md 82a94ea1bd Add f303 to tinyuf2 bootloader support (#19620) пре 3 година
flashing_bootloadhid.md 01f31bf28e [Docs] RESET -> QK_BOOT (#18365) пре 3 година
fuse.txt 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) пре 5 година
getting_started_docker.md b56282756b [Docs] Clean up some code block languages (#14434) пре 5 година
getting_started_github.md b2a186cf92 Purge uGFX. (#14720) пре 4 година
getting_started_introduction.md 09c7304bd9 [Docs] update git command and directory name of documents (#7619) пре 6 година
getting_started_make_guide.md 36d123e9c5 Add support for deferred executors. (#14859) пре 4 година
getting_started_vagrant.md b56282756b [Docs] Clean up some code block languages (#14434) пре 5 година
gpio_control.md cf935d97ae Fix functions with empty params (#19647) пре 3 година
hand_wire.md fc7e9efd21 Improve importer workflow (#17707) пре 4 година
hardware_drivers.md b2a186cf92 Purge uGFX. (#14720) пре 4 година
hardware_keyboard_guidelines.md 4704a4e053 Merge remote-tracking branch 'origin/master' into develop пре 3 година
how_a_matrix_works.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) пре 5 година
how_keyboards_work.md b85c224b7c docs: reflect systemd's change in language (#17322) пре 4 година
i2c_driver.md 81be7bb7b5 Fix i2c driver doc: Incorrect name (#16898) пре 4 година
index.html 94755308e0 Fix anchors with <code> in table of content (#15169) пре 4 година
isp_flashing_guide.md dde4120a1e ISP flashing guide: add instructions for flashing STM32duino bootloader (#16568) пре 4 година
keycodes.md 403b0addea Align magic keycodes (#19877) пре 3 година
keycodes_basic.md 0152dd811d Move `KC_MISSION_CONTROL`/`KC_LAUNCHPAD` keycodes to core (#19884) пре 3 година
keycodes_magic.md 403b0addea Align magic keycodes (#19877) пре 3 година
keycodes_us_ansi_shifted.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) пре 4 година
keymap.md 95671148a4 [Docs] Change defines to enums in examples (#19793) пре 3 година
mod_tap.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) пре 4 година
newbs.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) пре 5 година
newbs_building_firmware.md 32dabd5320 Align new-keymap with new-keyboard (#19229) пре 3 година
newbs_building_firmware_configurator.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) пре 5 година
newbs_building_firmware_workflow.md e6e11dfde7 Add disable git safe directory check step (#20040) пре 3 година
newbs_flashing.md 4e35697e1a Add note about qmk doctor in newbs_flashing.md (#15688) пре 4 година
newbs_getting_started.md 99a39a1198 Update newbs_getting_started to include instructions for apple silicon (#19579) пре 3 година
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 f667821ed3 [Docs] Resynchronizing Your Branch including submodules (#19268) пре 3 година
newbs_git_using_your_master_branch.md 54c58ea6de Add explicit id tags to externally linked headers пре 6 година
newbs_learn_more_resources.md 70c6b183df [Docs] Refactor code examples (#18003) пре 4 година
newbs_testing_debugging.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) пре 5 година
one_shot_keys.md 9ddb0165a4 fix typo (#19189) пре 3 година
other_eclipse.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) пре 4 година
other_vscode.md 12f02dd8be [Doc]Remove depracted extension links in vscode guide (#19842) пре 3 година
platformdev_blackpill_f4x1.md e5b36e2c3f Docs: typo fixes in platformdev_blackpill_f4x1.md (#19635) пре 3 година
platformdev_chibios_earlyinit.md 01f31bf28e [Docs] RESET -> QK_BOOT (#18365) пре 3 година
platformdev_proton_c.md 345e19f691 Add converter docs (#17593) пре 4 година
platformdev_rp2040.md 896d9aa98c Add rp2040_ce and add elite-pi and helios as alias (#19830) пре 3 година
platformdev_selecting_arm_mcu.md 3afd2d81b8 Add documentation for selecting an Arm MCU (#9046) пре 6 година
porting_your_keyboard_to_qmk.md f067f42305 [Docs] Discuss layout macro (#19803) пре 3 година
power.txt bb53635f33 Trim trailing whitespace пре 8 година
pr_checklist.md 9c79d2933c [Doc] Update PR checklist (#19988) пре 3 година
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 a6f3194397 Add ability to enter bootloader mode from `QK_MAKE` (#17745) пре 4 година
quantum_painter.md 45851a10f6 Add RGB565 and RGB888 color support to Quantum Painter (#19382) пре 3 година
quantum_painter_lvgl.md cf935d97ae Fix functions with empty params (#19647) пре 3 година
quantum_painter_qff.md 1f2b1dedcc Quantum Painter (#10174) пре 4 година
quantum_painter_qgf.md 1f2b1dedcc Quantum Painter (#10174) пре 4 година
quantum_painter_rle.md 1f2b1dedcc Quantum Painter (#10174) пре 4 година
redirects.json d569f08771 Configuration system for CLI (#6708) пре 7 година
ref_functions.md c347e732be Remove legacy EEPROM clear keycodes (#18782) пре 3 година
reference_configurator_support.md f529580860 Basic keycode overhaul (#14726) пре 4 година
reference_glossary.md 014aa0661e Fix Space Cadet md link (#14300) пре 5 година
reference_info_json.md 3fc9c03559 Remove `all` from list of animations in `info.json` (#19978) пре 3 година
reference_keymap_extras.md 4a8bd7b9a5 Rename keymap_extras headers for consistency (#16939) пре 4 година
serial_driver.md 3f45fd4924 Fix serial_driver.md list item numbering (#19819) пре 3 година
spi_driver.md 0e59827023 Merge remote-tracking branch 'upstream/master' into develop пре 5 година
squeezing_avr.md 896d9aa98c Add rp2040_ce and add elite-pi and helios as alias (#19830) пре 3 година
support.md e4823aadec Fix capitalisation of "GitHub" (#9184) пре 6 година
support_deprecation_policy.md d1a430b348 Initial deprecation policy documentation. (#19908) пре 3 година
sw.js 303f425c6b Fix up info boxes. пре 8 година
syllabus.md f4966a19d6 [Docs] Squeezing space out of AVR (#15243) пре 4 година
tap_hold.md 515dd18c28 Remove IGNORE_MOD_TAP_INTERRUPT_PER_KEY in favour of HOLD_ON_OTHER_KEY_PRESS_PER_KEY (#15741) пре 3 година
translating.md 7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) пре 6 година
uart_driver.md 04b51e381e Update UART driver API (#14839) пре 4 година
understanding_qmk.md 419a7944a4 Update understanding_qmk.md (#19664) пре 3 година
unit_testing.md 1c0347b8b8 Remove SERIAL_LINK feature (#14727) пре 4 година
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores пре 9 година
ws2812_driver.md 27dec8d16d [Core] Allow custom timings for WS2812 PIO driver (#18006) пре 3 година

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.