Halaman utama Jelajahi Bantuan
Masuk
logic855
/
qmk_firmware
cermin dari https://github.com/qmk/qmk_firmware.git
1
0
Fork 1
Berkas Masalah 0 Wiki
Pohon: 734c7afa7d
Ranting Tag
qmk_firmware
/
docs
Fabien Fellay 734c7afa7d Add missing rgb matrix default parameters (#22281) 2 tahun lalu
..
ChangeLog 07e7dd8fc1 `develop` 2023q4 changelog (#22552) 2 tahun lalu
gitbook 4580d3a730 RGB improvements (#1684) 9 tahun lalu
internals 75544d9127 Move Doxygen docs to subdirectory (#16561) 4 tahun lalu
ja e9bd7d7ad3 I2C driver cleanup (#21273) 2 tahun lalu
zh-cn 339bff6339 Move velocikey to within rgblight (#22123) 2 tahun lalu
.nojekyll 9e5676650e Use docsfy to replace gitbook 8 tahun lalu
CNAME 4d26137e2a Create CNAME 8 tahun lalu
README.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 tahun lalu
_langs.md 1c1e6fa47d Remove stale docs translations (#15737) 4 tahun lalu
_summary.md 07e7dd8fc1 `develop` 2023q4 changelog (#22552) 2 tahun lalu
adc_driver.md e884e42ce9 Generalise ADC driver source inclusion (#22448) 2 tahun lalu
apa102_driver.md a931e6d7bd Update WS2812 docs and add APA102 docs (#22106) 2 tahun lalu
api_development_environment.md 99850aabca Add API documentation 6 tahun lalu
api_development_overview.md 99850aabca Add API documentation 6 tahun lalu
api_docs.md 9e78e65a56 2022 Nov 26 changelog. (#19164) 3 tahun lalu
api_overview.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 tahun lalu
arm_debugging.md 52c18ef026 [Docs] fix docs (#7642) 6 tahun lalu
audio_driver.md 29f8fa35cf [Audio] Enable Complementary output for PWM Hardware driver (#22726) 2 tahun lalu
breaking_changes.md 07e7dd8fc1 `develop` 2023q4 changelog (#22552) 2 tahun lalu
breaking_changes_history.md 07e7dd8fc1 `develop` 2023q4 changelog (#22552) 2 tahun lalu
breaking_changes_instructions.md 32d865572c `develop` 2023q2 changelog (#21049) 3 tahun lalu
chibios_upgrade_instructions.md 7ebb8c2dec Update branch names to reflect configurator's new deployment. (#19999) 3 tahun lalu
cli.md cf3c8a2138 Give definition of 'CLI' for new users (#22647) 2 tahun lalu
cli_commands.md d95182f5b5 [documentation] QMK migrate docs patch (#22646) 2 tahun lalu
cli_configuration.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 tahun lalu
cli_development.md a638f6e5aa Fix minimum python version references (#22191) 2 tahun lalu
cli_tab_complete.md ee26d3e77f Add Zsh note for tab complete (#17226) 4 tahun lalu
coding_conventions_c.md 2f1cac6e9f [Docs] Code markdown amendment (#21323) 3 tahun lalu
coding_conventions_python.md a638f6e5aa Fix minimum python version references (#22191) 2 tahun lalu
compatible_microcontrollers.md c814be0296 STM32H723 support (#21352) 3 tahun lalu
config_options.md ccec4867c8 Align `SPLIT_HAND_MATRIX_GRID` left/right logic with `SPLIT_HAND_PIN` (#22775) 2 tahun lalu
configurator_architecture.md 9a0118c603 Architecture documentation for Configurator and API (#13935) 5 tahun lalu
configurator_default_keymaps.md 961f0b7b2d Reallocate SAFE_RANGE (#19909) 3 tahun lalu
configurator_diagram.drawio 9a0118c603 Architecture documentation for Configurator and API (#13935) 5 tahun lalu
configurator_diagram.svg 9a0118c603 Architecture documentation for Configurator and API (#13935) 5 tahun lalu
configurator_step_by_step.md f6a7f4d4ac update the Chinese translation based on the latest English version (#14924) 4 tahun lalu
configurator_troubleshooting.md d5f34c4810 Polish Configurator section 6 tahun lalu
contributing.md 8895b13583 Documentation regarding user code removal/acceptance (#22507) 2 tahun lalu
custom_matrix.md 11d49d00e7 Remove matrix_init_quantum/matrix_scan_quantum (#19806) 3 tahun lalu
custom_quantum_functions.md 07e7dd8fc1 `develop` 2023q4 changelog (#22552) 2 tahun lalu
data_driven_config.md ffdc70bf0a Consolidate `KEYBOARD_OUTPUT`+`KEYMAP_OUTPUT`=>`INTERMEDIATE_OUTPUT` (#21272) 3 tahun lalu
documentation_best_practices.md 995464cb9c [Docs] fix file path (#9540) 6 tahun lalu
documentation_templates.md b756c53c7b [Docs] Touch up documentation templates & porting keyboard docs (#19573) 3 tahun lalu
driver_installation_zadig.md 01f31bf28e [Docs] RESET -> QK_BOOT (#18365) 3 tahun lalu
easy_maker.md f6a7f4d4ac update the Chinese translation based on the latest English version (#14924) 4 tahun lalu
eeprom_driver.md bf6f13a2b0 Consolidate some EEPROM Driver configuration (#22321) 2 tahun lalu
faq_build.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 tahun lalu
faq_debug.md 18dc851e37 Remove legacy Debug keycode (#18769) 3 tahun lalu
faq_general.md d6701b3ac7 Fix typos and reword some sentences in FAQs (#11546) 5 tahun lalu
faq_keymap.md d241e80533 Keymap FAQ updates (#17130) 4 tahun lalu
faq_misc.md 01f31bf28e [Docs] RESET -> QK_BOOT (#18365) 3 tahun lalu
feature_advanced_keycodes.md e1afcda1c0 Update code example to match description (#20528) 3 tahun lalu
feature_audio.md 69fa02c37d Align audio keycode names (#18962) 3 tahun lalu
feature_auto_shift.md dd94877ec6 Improve test invocation, fix Retro Shift bugs, and add Auto+Retro Shift test cases (#15889) 2 tahun lalu
feature_autocorrect.md 55295ed3dc [Enhancement] More info on `apply_autocorrect` (#21056) 3 tahun lalu
feature_backlight.md 7ae826476e Move BACKLIGHT_PWM_PERIOD to correct docs section (#22480) 2 tahun lalu
feature_bluetooth.md b4a7b9253a Bluetooth: driver naming cleanups (#21624) 3 tahun lalu
feature_bootmagic.md 9aaf4a5a9b Add split keyboard example for Bootmagic Lite (#16349) 4 tahun lalu
feature_caps_word.md ae63c0f509 [Core] Caps Word "Invert on shift" option: pressing Shift inverts the shift state. (#20092) 3 tahun lalu
feature_combo.md 0fb3aaec8e [Doc]: Correct Markdown syntax errors. (#22511) 2 tahun lalu
feature_command.md a03aa301de Remove Full Bootmagic (#13846) 5 tahun lalu
feature_converters.md 2450fe28ee Add Imera converter (#22419) 2 tahun lalu
feature_debounce_type.md f56cf93fa1 Add debounce time description (#20333) 3 tahun lalu
feature_digitizer.md 6cc9513ab0 Digitizer feature improvements (#19034) 3 tahun lalu
feature_dip_switch.md 4682226e20 Keymap introspection for Dip Switches (#22543) 2 tahun lalu
feature_dynamic_macros.md 68efea70b2 Add direction to dynamic_macro_record_start_user (#19689) 3 tahun lalu
feature_eeprom.md 7407347be1 Remove rgblight_list.h (#18878) 3 tahun lalu
feature_encoders.md 567f808ea5 [Doc] Use number indexes for encoder code example (#22980) 2 tahun lalu
feature_grave_esc.md b45a037c7e Rename some Quantum keycodes (#15968) 4 tahun lalu
feature_haptic_feedback.md 0b802defd4 haptic: further naming cleanups (#21682) 3 tahun lalu
feature_hd44780.md 12edfc0c69 Fix anchor IDs for some API references (#21345) 3 tahun lalu
feature_joystick.md 917d93e968 [Docs] Fix `JOYSTICK_AXIS_COUNT` name in docs (#19605) 3 tahun lalu
feature_key_lock.md eeb3f9c043 Merge remote-tracking branch 'origin/master' into develop 3 tahun lalu
feature_key_overrides.md 50844a8e67 Fix typos: key-modifer→key-modifier and interacton→interaction (#22464) 2 tahun lalu
feature_layers.md b9c4bd0d66 Changed interverts to inverts (#21270) 3 tahun lalu
feature_layouts.md b56282756b [Docs] Clean up some code block languages (#14434) 4 tahun lalu
feature_leader_key.md bbf7a20b33 Refactor Leader key feature (#19632) 3 tahun lalu
feature_led_indicators.md 1124bbc1db Remove deprecated led_set_kb (#19273) 3 tahun lalu
feature_led_matrix.md 734c7afa7d Add missing rgb matrix default parameters (#22281) 2 tahun lalu
feature_macros.md ce81801480 Add latam spanish headers (#22542) 2 tahun lalu
feature_midi.md 650864c27d Merge remote-tracking branch 'origin/master' into develop 3 tahun lalu
feature_mouse_keys.md a05e5b5554 Add MOUSEKEY_WHEEL_DELTA documentation (#21493) 3 tahun lalu
feature_oled_driver.md 0fb3aaec8e [Doc]: Correct Markdown syntax errors. (#22511) 2 tahun lalu
feature_os_detection.md 147865cf57 Migrate some common features to generic (#22403) 2 tahun lalu
feature_pointing_device.md 6b52c6d83d Cirque reachable calibration aide (#22803) 2 tahun lalu
feature_programmable_button.md 17ae28f0e4 Fix doc for programmable buttons. (#22136) 2 tahun lalu
feature_ps2_mouse.md 4d994458f0 Document the RP2040-specific PS/2 implementation (#22079) 2 tahun lalu
feature_rawhid.md 31fdf7d899 add pywinusb lib to list of example libs for HID (#22747) 2 tahun lalu
feature_repeat_key.md 3993b15f05 [Core] Add Repeat Key ("repeat last key") as a core feature. (#19700) 3 tahun lalu
feature_rgb_matrix.md 734c7afa7d Add missing rgb matrix default parameters (#22281) 2 tahun lalu
feature_rgblight.md e648155113 Rename `RGBLED_NUM` -> `RGBLIGHT_LED_COUNT` (#22570) 2 tahun lalu
feature_secure.md ec2414c074 Deprecate `SECURE_*` keycodes for `QK_SECURE_*` (#18847) 3 tahun lalu
feature_send_string.md 12edfc0c69 Fix anchor IDs for some API references (#21345) 3 tahun lalu
feature_sequencer.md f587a0c548 Align sequencer keycodes (#19875) 3 tahun lalu
feature_space_cadet.md 725c9f3c85 Use wayback machine for unreachable site (#20987) 3 tahun lalu
feature_split_keyboard.md ccec4867c8 Align `SPLIT_HAND_MATRIX_GRID` left/right logic with `SPLIT_HAND_PIN` (#22775) 2 tahun lalu
feature_st7565.md 37fba09021 ST7565 invert (#13237) 5 tahun lalu
feature_stenography.md 786ebf8760 Remove requirement for `keymap_steno.h` include in keymaps (#22423) 2 tahun lalu
feature_swap_hands.md f5b7491883 Add swap hands toggle functions (#20381) 3 tahun lalu
feature_tap_dance.md b824faca71 Align location of tap dance keycode (#22742) 2 tahun lalu
feature_tri_layer.md 6e6fff866e Fix typo in `docs/feature_tri_layer.md` (#22232) 2 tahun lalu
feature_unicode.md 509a2b40b7 Fix old usage of UNICODE_MODE_MAC (#22238) 2 tahun lalu
feature_userspace.md 8895b13583 Documentation regarding user code removal/acceptance (#22507) 2 tahun lalu
feature_wpm.md 990ee8075e Fix typo in `feature_wpm.md` title (#20464) 3 tahun lalu
flash_driver.md 71c0b97bce Added external spi flash driver. (#15419) 4 tahun lalu
flashing.md a0ea7a6b17 feat, docs: WB32 flashing (#21217) 3 tahun lalu
flashing_bootloadhid.md 01f31bf28e [Docs] RESET -> QK_BOOT (#18365) 3 tahun lalu
fuse.txt 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 tahun lalu
getting_started_docker.md b56282756b [Docs] Clean up some code block languages (#14434) 4 tahun lalu
getting_started_github.md b2a186cf92 Purge uGFX. (#14720) 4 tahun lalu
getting_started_introduction.md 09c7304bd9 [Docs] update git command and directory name of documents (#7619) 6 tahun lalu
getting_started_make_guide.md a4ed6ad0f5 Unicodemap keycodes rename (#21092) 3 tahun lalu
gpio_control.md cf935d97ae Fix functions with empty params (#19647) 3 tahun lalu
hand_wire.md fc7e9efd21 Improve importer workflow (#17707) 4 tahun lalu
hardware_drivers.md b2a186cf92 Purge uGFX. (#14720) 4 tahun lalu
hardware_keyboard_guidelines.md e648155113 Rename `RGBLED_NUM` -> `RGBLIGHT_LED_COUNT` (#22570) 2 tahun lalu
how_a_matrix_works.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 tahun lalu
how_keyboards_work.md b85c224b7c docs: reflect systemd's change in language (#17322) 4 tahun lalu
i2c_driver.md e9bd7d7ad3 I2C driver cleanup (#21273) 2 tahun lalu
index.html 94755308e0 Fix anchors with <code> in table of content (#15169) 4 tahun lalu
isp_flashing_guide.md 952cdc7be5 Adds Docs option for ArduinoIDE's example `ArduinoISP` (#20486) 3 tahun lalu
keycodes.md a4ed6ad0f5 Unicodemap keycodes rename (#21092) 3 tahun lalu
keycodes_basic.md 0152dd811d Move `KC_MISSION_CONTROL`/`KC_LAUNCHPAD` keycodes to core (#19884) 3 tahun lalu
keycodes_magic.md 403b0addea Align magic keycodes (#19877) 3 tahun lalu
keycodes_us_ansi_shifted.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) 4 tahun lalu
keymap.md a474cac2c3 Update keymap.md (#22834) 2 tahun lalu
mod_tap.md 1899793f27 Make IGNORE_MOD_TAP_INTERRUPT the default behaviour for mod-taps (#20211) 3 tahun lalu
newbs.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 tahun lalu
newbs_building_firmware.md 32dabd5320 Align new-keymap with new-keyboard (#19229) 3 tahun lalu
newbs_building_firmware_configurator.md f35cb924e9 Update newbs docs with some rp2040 stuff (#21186) 3 tahun lalu
newbs_building_firmware_workflow.md 0fb3aaec8e [Doc]: Correct Markdown syntax errors. (#22511) 2 tahun lalu
newbs_external_userspace.md 5501e804ff QMK Userspace (#22222) 2 tahun lalu
newbs_flashing.md f35cb924e9 Update newbs docs with some rp2040 stuff (#21186) 3 tahun lalu
newbs_getting_started.md 8813bdf5dd Remove rosetta instructions for Apple Silicon (#22174) 2 tahun lalu
newbs_git_best_practices.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) 6 tahun lalu
newbs_git_resolving_merge_conflicts.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) 6 tahun lalu
newbs_git_resynchronize_a_branch.md f667821ed3 [Docs] Resynchronizing Your Branch including submodules (#19268) 3 tahun lalu
newbs_git_using_your_master_branch.md 54c58ea6de Add explicit id tags to externally linked headers 6 tahun lalu
newbs_learn_more_resources.md 70c6b183df [Docs] Refactor code examples (#18003) 4 tahun lalu
newbs_testing_debugging.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 tahun lalu
one_shot_keys.md 9ddb0165a4 fix typo (#19189) 3 tahun lalu
other_eclipse.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) 4 tahun lalu
other_vscode.md 1ca34c2168 Fix VS code live share extension link (#21585) 3 tahun lalu
platformdev_blackpill_f4x1.md e5b36e2c3f Docs: typo fixes in platformdev_blackpill_f4x1.md (#19635) 3 tahun lalu
platformdev_chibios_earlyinit.md 01f31bf28e [Docs] RESET -> QK_BOOT (#18365) 3 tahun lalu
platformdev_proton_c.md 345e19f691 Add converter docs (#17593) 4 tahun lalu
platformdev_rp2040.md 896d9aa98c Add rp2040_ce and add elite-pi and helios as alias (#19830) 3 tahun lalu
platformdev_selecting_arm_mcu.md 3afd2d81b8 Add documentation for selecting an Arm MCU (#9046) 6 tahun lalu
porting_your_keyboard_to_qmk.md f067f42305 [Docs] Discuss layout macro (#19803) 3 tahun lalu
power.txt bb53635f33 Trim trailing whitespace 8 tahun lalu
pr_checklist.md 5031e0e35c [docs] - reword PR checklist for vendor keymaps/userspace changes (#22725) 2 tahun lalu
qmk.css ccc87421e7 Some more tweaks to make everything look nice 8 tahun lalu
qmk_custom_dark.css e3c6467ab9 [Docs] Improve contrast for warnings in dark mode (#21928) 2 tahun lalu
qmk_custom_light.css 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 tahun lalu
quantum_keycodes.md 7bd1d18427 [Docs] Add note about `ENABLE_COMPILE_KEYCODE` to docs (#21290) 3 tahun lalu
quantum_painter.md 18630b741e Add QP support for smaller OLED displays and SSD1306 (#22358) 2 tahun lalu
quantum_painter_lvgl.md 169b0f33f6 Lvgl rate control (#22049) 2 tahun lalu
quantum_painter_qff.md 1f2b1dedcc Quantum Painter (#10174) 4 tahun lalu
quantum_painter_qgf.md 1f2b1dedcc Quantum Painter (#10174) 4 tahun lalu
quantum_painter_rle.md 1f2b1dedcc Quantum Painter (#10174) 4 tahun lalu
redirects.json d569f08771 Configuration system for CLI (#6708) 6 tahun lalu
ref_functions.md c347e732be Remove legacy EEPROM clear keycodes (#18782) 3 tahun lalu
reference_configurator_support.md f529580860 Basic keycode overhaul (#14726) 4 tahun lalu
reference_glossary.md 4818e14c77 Breaking changes changelog, 2023q3 version (#21848) 2 tahun lalu
reference_info_json.md b24bd2351a Remove redundant audio eeconfig init (#22736) 2 tahun lalu
reference_keymap_extras.md e67d2c2f6f Add Canadian French input locale (#21456) 2 tahun lalu
serial_driver.md e0c00c35ce Clarify PIO define is optional in docs. (#22339) 2 tahun lalu
spi_driver.md c157c19b81 Dedupe I2C, SPI, UART driver inclusions (#22253) 2 tahun lalu
squeezing_avr.md 2450fe28ee Add Imera converter (#22419) 2 tahun lalu
support.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 tahun lalu
support_deprecation_policy.md d1a430b348 Initial deprecation policy documentation. (#19908) 3 tahun lalu
sw.js 303f425c6b Fix up info boxes. 8 tahun lalu
syllabus.md f4966a19d6 [Docs] Squeezing space out of AVR (#15243) 4 tahun lalu
tap_hold.md 87eaab600c Fixed non-executable codes in the documentation (#22600) 2 tahun lalu
translating.md 7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) 6 tahun lalu
uart_driver.md c157c19b81 Dedupe I2C, SPI, UART driver inclusions (#22253) 2 tahun lalu
understanding_qmk.md 21b660fa07 Move `pre_process_record_kb()` before `process_combo()` (#20969) 3 tahun lalu
unit_testing.md dd94877ec6 Improve test invocation, fix Retro Shift bugs, and add Auto+Retro Shift test cases (#15889) 2 tahun lalu
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores 9 tahun lalu
ws2812_driver.md a931e6d7bd Update WS2812 docs and add APA102 docs (#22106) 2 tahun lalu

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.