Почетна Преглед Помоћ
Пријавите се
logic855
/
qmk_firmware
огледало од https://github.com/qmk/qmk_firmware.git
1
0
Креирај огранак 1
Датотеке Дискусије 0 Вики
Дрво: 7b838f330f
Гране Ознаке
qmk_firmware
/
docs
Nick Brassel 33c453d771 PR Checklist: explain wireless requirements. (#23584) пре 2 година
..
ChangeLog dc046bc215 2024q1 `develop` changelog. (#23150) пре 2 година
gitbook 4580d3a730 RGB improvements (#1684) пре 9 година
internals 75544d9127 Move Doxygen docs to subdirectory (#16561) пре 4 година
ja e2dbe39b94 Removal of bootmagic lite terminology (#22979) пре 2 година
zh-cn 339bff6339 Move velocikey to within rgblight (#22123) пре 2 година
.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 dc046bc215 2024q1 `develop` changelog. (#23150) пре 2 година
adc_driver.md e884e42ce9 Generalise ADC driver source inclusion (#22448) пре 2 година
apa102_driver.md a931e6d7bd Update WS2812 docs and add APA102 docs (#22106) пре 2 година
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 29f8fa35cf [Audio] Enable Complementary output for PWM Hardware driver (#22726) пре 2 година
breaking_changes.md dc046bc215 2024q1 `develop` changelog. (#23150) пре 2 година
breaking_changes_history.md dc046bc215 2024q1 `develop` changelog. (#23150) пре 2 година
breaking_changes_instructions.md 32d865572c `develop` 2023q2 changelog (#21049) пре 3 година
chibios_upgrade_instructions.md 7ebb8c2dec Update branch names to reflect configurator's new deployment. (#19999) пре 3 година
cli.md cf3c8a2138 Give definition of 'CLI' for new users (#22647) пре 2 година
cli_commands.md d95182f5b5 [documentation] QMK migrate docs patch (#22646) пре 2 година
cli_configuration.md e4823aadec Fix capitalisation of "GitHub" (#9184) пре 6 година
cli_development.md a638f6e5aa Fix minimum python version references (#22191) пре 2 година
cli_tab_complete.md ee26d3e77f Add Zsh note for tab complete (#17226) пре 4 година
coding_conventions_c.md 2f1cac6e9f [Docs] Code markdown amendment (#21323) пре 3 година
coding_conventions_python.md a638f6e5aa Fix minimum python version references (#22191) пре 2 година
compatible_microcontrollers.md c814be0296 STM32H723 support (#21352) пре 3 година
config_options.md ccec4867c8 Align `SPLIT_HAND_MATRIX_GRID` left/right logic with `SPLIT_HAND_PIN` (#22775) пре 2 година
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 8895b13583 Documentation regarding user code removal/acceptance (#22507) пре 2 година
custom_matrix.md 11d49d00e7 Remove matrix_init_quantum/matrix_scan_quantum (#19806) пре 3 година
custom_quantum_functions.md b8646bc40b Update naming convention for GPIO control macros (#23085) пре 2 година
data_driven_config.md ffdc70bf0a Consolidate `KEYBOARD_OUTPUT`+`KEYMAP_OUTPUT`=>`INTERMEDIATE_OUTPUT` (#21272) пре 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 29891b63f9 Update Atmel DFU driver assignments for dfu-programmer 1.x (#23165) пре 2 година
easy_maker.md f6a7f4d4ac update the Chinese translation based on the latest English version (#14924) пре 4 година
eeprom_driver.md bf6f13a2b0 Consolidate some EEPROM Driver configuration (#22321) пре 2 година
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 e1afcda1c0 Update code example to match description (#20528) пре 3 година
feature_audio.md 69fa02c37d Align audio keycode names (#18962) пре 3 година
feature_auto_shift.md dd94877ec6 Improve test invocation, fix Retro Shift bugs, and add Auto+Retro Shift test cases (#15889) пре 2 година
feature_autocorrect.md 55295ed3dc [Enhancement] More info on `apply_autocorrect` (#21056) пре 3 година
feature_backlight.md 7ae826476e Move BACKLIGHT_PWM_PERIOD to correct docs section (#22480) пре 2 година
feature_bluetooth.md b4a7b9253a Bluetooth: driver naming cleanups (#21624) пре 3 година
feature_bootmagic.md e2dbe39b94 Removal of bootmagic lite terminology (#22979) пре 2 година
feature_caps_word.md ae63c0f509 [Core] Caps Word "Invert on shift" option: pressing Shift inverts the shift state. (#20092) пре 3 година
feature_combo.md 7df44ffb75 Fix double code indenting (#23117) пре 2 година
feature_command.md a03aa301de Remove Full Bootmagic (#13846) пре 5 година
feature_converters.md 2450fe28ee Add Imera converter (#22419) пре 2 година
feature_debounce_type.md f56cf93fa1 Add debounce time description (#20333) пре 3 година
feature_digitizer.md 6cc9513ab0 Digitizer feature improvements (#19034) пре 3 година
feature_dip_switch.md 4682226e20 Keymap introspection for Dip Switches (#22543) пре 2 година
feature_dynamic_macros.md 68efea70b2 Add direction to dynamic_macro_record_start_user (#19689) пре 3 година
feature_eeprom.md 7407347be1 Remove rgblight_list.h (#18878) пре 3 година
feature_encoders.md 567f808ea5 [Doc] Use number indexes for encoder code example (#22980) пре 2 година
feature_grave_esc.md b45a037c7e Rename some Quantum keycodes (#15968) пре 4 година
feature_haptic_feedback.md 0b802defd4 haptic: further naming cleanups (#21682) пре 3 година
feature_hd44780.md 12edfc0c69 Fix anchor IDs for some API references (#21345) пре 3 година
feature_joystick.md 77e8867498 Fix joystick initialization (#22953) пре 2 година
feature_key_lock.md eeb3f9c043 Merge remote-tracking branch 'origin/master' into develop пре 3 година
feature_key_overrides.md 50844a8e67 Fix typos: key-modifer→key-modifier and interacton→interaction (#22464) пре 2 година
feature_layers.md b9c4bd0d66 Changed interverts to inverts (#21270) пре 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 b8646bc40b Update naming convention for GPIO control macros (#23085) пре 2 година
feature_led_matrix.md 3ba88f7798 LED drivers: update PWM register defines for `g_<driver>_leds` (#23052) пре 2 година
feature_macros.md ce81801480 Add latam spanish headers (#22542) пре 2 година
feature_midi.md 650864c27d Merge remote-tracking branch 'origin/master' into develop пре 3 година
feature_mouse_keys.md a05e5b5554 Add MOUSEKEY_WHEEL_DELTA documentation (#21493) пре 3 година
feature_oled_driver.md 0fb3aaec8e [Doc]: Correct Markdown syntax errors. (#22511) пре 2 година
feature_os_detection.md 80f3da36e5 [Core] Add OS detection callbacks (#21777) пре 2 година
feature_pointing_device.md 6b52c6d83d Cirque reachable calibration aide (#22803) пре 2 година
feature_programmable_button.md 17ae28f0e4 Fix doc for programmable buttons. (#22136) пре 2 година
feature_ps2_mouse.md 4d994458f0 Document the RP2040-specific PS/2 implementation (#22079) пре 2 година
feature_rawhid.md 31fdf7d899 add pywinusb lib to list of example libs for HID (#22747) пре 2 година
feature_repeat_key.md 3993b15f05 [Core] Add Repeat Key ("repeat last key") as a core feature. (#19700) пре 3 година
feature_rgb_matrix.md 3ba88f7798 LED drivers: update PWM register defines for `g_<driver>_leds` (#23052) пре 2 година
feature_rgblight.md e648155113 Rename `RGBLED_NUM` -> `RGBLIGHT_LED_COUNT` (#22570) пре 2 година
feature_secure.md ec2414c074 Deprecate `SECURE_*` keycodes for `QK_SECURE_*` (#18847) пре 3 година
feature_send_string.md 12edfc0c69 Fix anchor IDs for some API references (#21345) пре 3 година
feature_sequencer.md f587a0c548 Align sequencer keycodes (#19875) пре 3 година
feature_space_cadet.md 725c9f3c85 Use wayback machine for unreachable site (#20987) пре 3 година
feature_split_keyboard.md ccec4867c8 Align `SPLIT_HAND_MATRIX_GRID` left/right logic with `SPLIT_HAND_PIN` (#22775) пре 2 година
feature_st7565.md 37fba09021 ST7565 invert (#13237) пре 5 година
feature_stenography.md 786ebf8760 Remove requirement for `keymap_steno.h` include in keymaps (#22423) пре 2 година
feature_swap_hands.md f5b7491883 Add swap hands toggle functions (#20381) пре 3 година
feature_tap_dance.md b824faca71 Align location of tap dance keycode (#22742) пре 2 година
feature_tri_layer.md 1080025973 Update feature_tri_layer.md - typo (#23275) пре 2 година
feature_unicode.md 509a2b40b7 Fix old usage of UNICODE_MODE_MAC (#22238) пре 2 година
feature_userspace.md 8895b13583 Documentation regarding user code removal/acceptance (#22507) пре 2 година
feature_wpm.md 990ee8075e Fix typo in `feature_wpm.md` title (#20464) пре 3 година
flash_driver.md 71c0b97bce Added external spi flash driver. (#15419) пре 4 година
flashing.md 696bf80375 Clearer text about double tapping reset only working for boot after already having QMK running in board (#23042) пре 2 година
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 f0e219a1c8 Modify wording in 'getting_started_introduction.md' (#23232) пре 2 година
getting_started_make_guide.md a4ed6ad0f5 Unicodemap keycodes rename (#21092) пре 3 година
gpio_control.md b8646bc40b Update naming convention for GPIO control macros (#23085) пре 2 година
hand_wire.md b0e948c380 Update hand_wire.md (#23429) пре 2 година
hardware_drivers.md b2a186cf92 Purge uGFX. (#14720) пре 4 година
hardware_keyboard_guidelines.md e648155113 Rename `RGBLED_NUM` -> `RGBLIGHT_LED_COUNT` (#22570) пре 2 година
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 b8646bc40b Update naming convention for GPIO control macros (#23085) пре 2 година
index.html 94755308e0 Fix anchors with <code> in table of content (#15169) пре 4 година
isp_flashing_guide.md 952cdc7be5 Adds Docs option for ArduinoIDE's example `ArduinoISP` (#20486) пре 3 година
keycodes.md a4ed6ad0f5 Unicodemap keycodes rename (#21092) пре 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 a474cac2c3 Update keymap.md (#22834) пре 2 година
mod_tap.md 1899793f27 Make IGNORE_MOD_TAP_INTERRUPT the default behaviour for mod-taps (#20211) пре 3 година
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 f35cb924e9 Update newbs docs with some rp2040 stuff (#21186) пре 3 година
newbs_building_firmware_workflow.md 0fb3aaec8e [Doc]: Correct Markdown syntax errors. (#22511) пре 2 година
newbs_external_userspace.md 5501e804ff QMK Userspace (#22222) пре 2 година
newbs_flashing.md f35cb924e9 Update newbs docs with some rp2040 stuff (#21186) пре 3 година
newbs_getting_started.md 8813bdf5dd Remove rosetta instructions for Apple Silicon (#22174) пре 2 година
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 8946aace5b Add instructions for debugging ARM with VSCode+BMP. (#11217) пре 2 година
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 61fa6949fb [Core] Allow ChibiOS `SIO` driver for `UART` driver (#22839) пре 2 година
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 33c453d771 PR Checklist: explain wireless requirements. (#23584) пре 2 година
qmk.css ccc87421e7 Some more tweaks to make everything look nice пре 8 година
qmk_custom_dark.css e3c6467ab9 [Docs] Improve contrast for warnings in dark mode (#21928) пре 2 година
qmk_custom_light.css 4e8166750b Small tweaks to docs to make them more user friendly (#11518) пре 5 година
quantum_keycodes.md 7bd1d18427 [Docs] Add note about `ENABLE_COMPILE_KEYCODE` to docs (#21290) пре 3 година
quantum_painter.md 5383335717 [Driver] ILI9486 on Quantum Painter (#18521) пре 2 година
quantum_painter_lvgl.md 169b0f33f6 Lvgl rate control (#22049) пре 2 година
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 4818e14c77 Breaking changes changelog, 2023q3 version (#21848) пре 3 година
reference_info_json.md f6709e65eb Add RGB matrix & LED Matrix support for IS31FL3729 (#21944) пре 2 година
reference_keymap_extras.md e67d2c2f6f Add Canadian French input locale (#21456) пре 2 година
serial_driver.md 7bff385840 Update serial_driver.md (#23035) пре 2 година
spi_driver.md c157c19b81 Dedupe I2C, SPI, UART driver inclusions (#22253) пре 2 година
squeezing_avr.md 2450fe28ee Add Imera converter (#22419) пре 2 година
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 87eaab600c Fixed non-executable codes in the documentation (#22600) пре 2 година
translating.md 7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) пре 6 година
uart_driver.md 61fa6949fb [Core] Allow ChibiOS `SIO` driver for `UART` driver (#22839) пре 2 година
understanding_qmk.md 21b660fa07 Move `pre_process_record_kb()` before `process_combo()` (#20969) пре 3 година
unit_testing.md dd94877ec6 Improve test invocation, fix Retro Shift bugs, and add Auto+Retro Shift test cases (#15889) пре 2 година
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores пре 9 година
ws2812_driver.md a931e6d7bd Update WS2812 docs and add APA102 docs (#22106) пре 2 година

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.