mirrors/keychron_qmk_firmware
mirrors/keychron_qmk_firmware
0
0
Fork 0
mirror of https://github.com/Keychron/qmk_firmware.git synced 2024-11-22 08:27:56 +06:00
Code Issues Packages Projects Releases Wiki Activity
7e57552e30
keychron_qmk_firmware/docs
History
lokher e4f4ceaf3f merge upstream 713427c
2023-04-26 16:32:15 +08:00
..
ChangeLog merge upstream 713427c 2023-04-26 16:32:15 +08:00
gitbook/images
internals Move Doxygen docs to subdirectory (#16561) 2022-03-07 11:22:22 +00:00
ja merge upstream 713427c 2023-04-26 16:32:15 +08:00
zh-cn merge upstream 713427c 2023-04-26 16:32:15 +08:00
_langs.md
_summary.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
.nojekyll
adc_driver.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
api_development_environment.md
api_development_overview.md
api_docs.md 2022 Nov 26 changelog. (#19164) 2022-11-28 07:33:55 +11:00
api_overview.md
arm_debugging.md
audio_driver.md [Core] Adjust PWM hardware audio driver for RP2040 (#17723) 2022-10-27 19:26:16 +02:00
breaking_changes_history.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
breaking_changes_instructions.md
breaking_changes.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
chibios_upgrade_instructions.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
cli_commands.md docs: some typos (#18582) 2022-10-05 17:32:07 +01:00
cli_configuration.md
cli_development.md docs: some typos (#18582) 2022-10-05 17:32:07 +01:00
cli_tab_complete.md Add Zsh note for tab complete (#17226) 2022-07-02 21:59:59 +10:00
cli.md
CNAME
coding_conventions_c.md docs: some typos (#18582) 2022-10-05 17:32:07 +01:00
coding_conventions_python.md docs: some typos (#18582) 2022-10-05 17:32:07 +01:00
compatible_microcontrollers.md Tentative Teensy 3.5 support (#14420) 2022-07-03 00:12:45 +10:00
config_options.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
configurator_architecture.md
configurator_default_keymaps.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
configurator_diagram.drawio
configurator_diagram.svg
configurator_step_by_step.md update the Chinese translation based on the latest English version (#14924) 2022-01-18 18:24:02 +00:00
configurator_troubleshooting.md
contributing.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
custom_matrix.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
custom_quantum_functions.md [Docs] Extract 'Layer Change Code' and EEPROM (#18174) 2022-09-19 02:20:22 +01:00
data_driven_config.md Format DD mappings and schemas (#18924) 2022-11-08 01:05:08 +00:00
documentation_best_practices.md
documentation_templates.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
driver_installation_zadig.md [Docs] RESET -> QK_BOOT (#18365) 2022-09-15 01:03:55 +01:00
easy_maker.md update the Chinese translation based on the latest English version (#14924) 2022-01-18 18:24:02 +00:00
eeprom_driver.md RP2040 emulated EEPROM. (#17519) 2022-07-02 15:18:50 +10:00
faq_build.md
faq_debug.md Remove legacy Debug keycode (#18769) 2022-10-19 11:33:05 +01:00
faq_general.md
faq_keymap.md Keymap FAQ updates (#17130) 2022-05-18 04:48:59 +10:00
faq_misc.md [Docs] RESET -> QK_BOOT (#18365) 2022-09-15 01:03:55 +01:00
feature_advanced_keycodes.md [Docs] Extract 'Layer Change Code' and EEPROM (#18174) 2022-09-19 02:20:22 +01:00
feature_audio.md Align audio keycode names (#18962) 2022-11-05 17:05:19 +00:00
feature_auto_shift.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
feature_autocorrect.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
feature_backlight.md Reworked backlight keycodes. (#18961) 2022-11-06 08:11:59 +11:00
feature_bluetooth.md Normalise output selection (Bluetooth) keycodes (#19004) 2022-11-08 19:03:31 +00:00
feature_bootmagic.md Add split keyboard example for Bootmagic Lite (#16349) 2022-03-15 01:31:17 -07:00
feature_caps_word.md Deprecate CAPS_WORD/CAPSWRD for CW_TOGG (#18834) 2022-10-24 17:30:37 +01:00
feature_combo.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
feature_command.md
feature_converters.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
feature_debounce_type.md
feature_digitizer.md Digitizer feature improvements (#19034) 2022-11-12 23:28:11 +00:00
feature_dip_switch.md
feature_dynamic_macros.md Normalise Dynamic Macro keycodes (#18939) 2022-11-03 23:01:06 +00:00
feature_eeprom.md Remove rgblight_list.h (#18878) 2022-10-27 23:50:14 +01:00
feature_encoders.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
feature_grave_esc.md Rename some Quantum keycodes (#15968) 2022-01-22 03:34:15 +00:00
feature_haptic_feedback.md Align haptic feedback keycode names (#18964) 2022-11-07 02:43:53 +00:00
feature_hd44780.md HD44780 driver rework (#16370) 2022-03-19 17:57:22 +11:00
feature_joystick.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
feature_key_lock.md Merge remote-tracking branch 'origin/master' into develop 2022-10-24 23:28:56 -07:00
feature_key_overrides.md Deprecate KEY_OVERRIDE_* keycodes for KO_* (#18843) 2022-10-25 14:45:57 +01:00
feature_layers.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
feature_layouts.md
feature_leader_key.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
feature_led_indicators.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
feature_led_matrix.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
feature_macros.md Macro keycode name refactoring (#18958) 2022-11-05 23:22:11 +11:00
feature_midi.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
feature_mouse_keys.md add "inertia" mode for mouse keys (#18774) 2022-10-26 20:49:44 +01:00
feature_oled_driver.md Update OLED doc (#19213) 2022-11-30 17:48:23 +00:00
feature_os_detection.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
feature_pointing_device.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
feature_programmable_button.md Normalise Joystick and Programmable Button keycodes (#18832) 2022-10-24 15:50:33 +01:00
feature_ps2_mouse.md [Core] Rework PS/2 driver selection (#17892) 2022-08-31 09:16:07 +02:00
feature_rawhid.md
feature_rgb_matrix.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
feature_rgblight.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
feature_secure.md Deprecate SECURE_* keycodes for QK_SECURE_* (#18847) 2022-10-25 22:59:17 +01:00
feature_send_string.md Feature-ify Send String (#17275) 2022-07-02 22:10:08 +10:00
feature_sequencer.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
feature_space_cadet.md Normalise Space Cadet keycodes (#18864) 2022-10-27 11:19:16 +01:00
feature_split_keyboard.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
feature_st7565.md
feature_stenography.md Rename postprocess_steno_user → post_process_steno_user (#17823) 2022-07-28 21:51:01 -07:00
feature_swap_hands.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
feature_tap_dance.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
feature_tri_layer.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
feature_unicode.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
feature_userspace.md
feature_velocikey.md Deprecate VLK_TOG for VK_TOGG (#18807) 2022-10-22 21:45:20 +01:00
feature_wpm.md
flash_driver.md Added external spi flash driver. (#15419) 2022-02-11 20:26:16 +00:00
flashing_bootloadhid.md [Docs] RESET -> QK_BOOT (#18365) 2022-09-15 01:03:55 +01:00
flashing.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
fuse.txt
getting_started_docker.md
getting_started_github.md
getting_started_introduction.md
getting_started_make_guide.md
getting_started_vagrant.md
gpio_control.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
hand_wire.md Improve importer workflow (#17707) 2022-08-13 14:39:56 +01:00
hardware_drivers.md
hardware_keyboard_guidelines.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
how_a_matrix_works.md
how_keyboards_work.md docs: reflect systemd's change in language (#17322) 2022-06-06 23:29:59 +01:00
i2c_driver.md Fix i2c driver doc: Incorrect name (#16898) 2022-04-20 18:10:20 +01:00
index.html Fix anchors with <code> in table of content (#15169) 2022-05-14 23:08:32 +01:00
isp_flashing_guide.md ISP flashing guide: add instructions for flashing STM32duino bootloader (#16568) 2022-03-13 23:55:47 +00:00
keycodes_basic.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
keycodes_magic.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
keycodes_us_ansi_shifted.md [Docs] Address some typos (also in moonlander matrix.c) (#16248) 2022-02-06 17:36:44 +00:00
keycodes.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
keymap.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
mod_tap.md [Docs] Address some typos (also in moonlander matrix.c) (#16248) 2022-02-06 17:36:44 +00:00
newbs_building_firmware_configurator.md
newbs_building_firmware_workflow.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
newbs_building_firmware.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
newbs_flashing.md Add note about qmk doctor in newbs_flashing.md (#15688) 2022-07-02 22:48:44 +10:00
newbs_getting_started.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
newbs_git_best_practices.md
newbs_git_resolving_merge_conflicts.md
newbs_git_resynchronize_a_branch.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
newbs_git_using_your_master_branch.md
newbs_learn_more_resources.md [Docs] Refactor code examples (#18003) 2022-08-12 17:27:24 -07:00
newbs_testing_debugging.md
newbs.md
one_shot_keys.md fix typo (#19189) 2022-11-29 16:34:20 +00:00
other_eclipse.md [Docs] Address some typos (also in moonlander matrix.c) (#16248) 2022-02-06 17:36:44 +00:00
other_vscode.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
platformdev_blackpill_f4x1.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
platformdev_chibios_earlyinit.md [Docs] RESET -> QK_BOOT (#18365) 2022-09-15 01:03:55 +01:00
platformdev_proton_c.md Add converter docs (#17593) 2022-07-08 22:49:16 +01:00
platformdev_rp2040.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
platformdev_selecting_arm_mcu.md
porting_your_keyboard_to_qmk.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
power.txt
pr_checklist.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
qmk_custom_dark.css
qmk_custom_light.css
qmk.css
quantum_keycodes.md Add ability to enter bootloader mode from QK_MAKE (#17745) 2022-07-23 17:43:32 +01:00
quantum_painter_lvgl.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
quantum_painter_qff.md Quantum Painter (#10174) 2022-04-13 18:00:18 +10:00
quantum_painter_qgf.md Quantum Painter (#10174) 2022-04-13 18:00:18 +10:00
quantum_painter_rle.md Quantum Painter (#10174) 2022-04-13 18:00:18 +10:00
quantum_painter.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
README.md
redirects.json
ref_functions.md Remove legacy EEPROM clear keycodes (#18782) 2022-10-20 12:20:07 +01:00
reference_configurator_support.md
reference_glossary.md
reference_info_json.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
reference_keymap_extras.md Rename keymap_extras headers for consistency (#16939) 2022-05-15 21:27:01 +10:00
serial_driver.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
spi_driver.md
squeezing_avr.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
support_deprecation_policy.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
support.md
sw.js
syllabus.md
tap_hold.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
translating.md
uart_driver.md
understanding_qmk.md merge upstream 713427c 2023-04-26 16:32:15 +08:00
unit_testing.md
usb_nkro.txt
ws2812_driver.md [Core] Allow custom timings for WS2812 PIO driver (#18006) 2022-11-10 07:58:15 +11:00

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
User friendly graphical interfaces, no programming knowledge required.

?> Advanced Use The Source
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.