首页 发现 帮助
注册 登录
HuiJun
/
qmk_firmware
1
0
派生 0
文件 工单管理 0 合并请求 0 Wiki
目录树: e3a21348c3
分支列表 标签列表
qmk_firmware
/
docs
Drashna Jaelre feb116c4f3 [Docs] Replace Switch Hitter link with Wayback Machine link (#7009) 5 年之前
..
ChangeLog d217307747 consistency 5 年之前
fr-FR feb116c4f3 [Docs] Replace Switch Hitter link with Wayback Machine link (#7009) 5 年之前
gitbook 4580d3a730 RGB improvements (#1684) 7 年之前
zh-cn feb116c4f3 [Docs] Replace Switch Hitter link with Wayback Machine link (#7009) 5 年之前
.nojekyll 9e5676650e Use docsfy to replace gitbook 7 年之前
CNAME 4d26137e2a Create CNAME 7 年之前
README.md 73ddb764cc Fix readme and contributing hyperlinks 7 年之前
_langs.md e7d95701bf [Docs] French translation of Complete Newbs Guide (#6901) 5 年之前
_summary.md 68072e931a Expose zh-cn docs, delete bad zh docs, add docs for adding translations (#6855) 5 年之前
arm_debugging.md de386e5972 Fixed typos in documentation (#6871) 5 年之前
becoming_a_qmk_collaborator.md 1acaf2b2c2 Tweak the wording in "Becoming a QMK Collaborator" 6 年之前
breaking_changes.md 0e96068d23 Update the breaking changes process so we always have a future branch (#6785) 5 年之前
cli.md 2707652c98 [Docs] CLI command to serve docs locally (#6956) 5 年之前
cli_configuration.md d569f08771 Configuration system for CLI (#6708) 5 年之前
cli_development.md d569f08771 Configuration system for CLI (#6708) 5 年之前
coding_conventions_c.md a25dd58bc5 QMK CLI and JSON keymap support (#6176) 6 年之前
coding_conventions_python.md a25dd58bc5 QMK CLI and JSON keymap support (#6176) 6 年之前
compatible_microcontrollers.md 7b0356d1d4 Convert all headings to Title Case 7 年之前
config_options.md 76378d74f5 ARM split - detect USB to select master/slave (#6424) 5 年之前
contributing.md 3e22af92ee [Docs] Add an important note about modifying user code (#6959) 5 年之前
custom_quantum_functions.md b62e160a89 Additional changes for Layer State typedef compatibility (#5906) 5 年之前
documentation_best_practices.md 303f425c6b Fix up info boxes. 7 年之前
documentation_templates.md 8454fa5e9f Update Document Templates to reflect newer wording and URLs (#4006) 6 年之前
driver_installation_zadig.md c7d0262be7 [Keyboard] Add Discipad, Update Zadig doc for USBaspLoader (#6771) 5 年之前
faq.md e6c638bed1 Overhaul the Getting Started section and add a FAQ section 7 年之前
faq_build.md fb7c65dc34 Add Zadig 101 to docs (#6585) 5 年之前
faq_debug.md f2c179de58 Remove superfluous JTAG disable code (#6445) 5 年之前
faq_general.md 5bb3fe7a35 Remove unanswered/unnecessary FAQ item 5 年之前
faq_keymap.md 384fef72d3 Replace instances of KEYMAP with LAYOUT 6 年之前
feature_advanced_keycodes.md c1c0cf73ce fix typo 6 年之前
feature_audio.md d534c72a54 Added keycodes for swapping and unswapping the Control and OS keys (#6110) 5 年之前
feature_auto_shift.md 303f425c6b Fix up info boxes. 7 年之前
feature_backlight.md 38aefaf78e ARM - Initial backlight support (#6487) 5 年之前
feature_bluetooth.md 914d42acd0 Update Bluetooth docs (#4062) 6 年之前
feature_bootmagic.md ad8dbd5ca5 ARM split - Add bootmagic/magic keycodes for setting handedness (#6545) 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 17e7762de7 Eager Per Row Debouncing added (added to Ergodox) (#5498) 6 年之前
feature_dip_switch.md dab4967f1b Add Dip Switch as a core feature (#6140) 5 年之前
feature_dynamic_macros.md 6caea0acfb Docs: Adjust dynamic macro docs to include more than the planck (#3509) 6 年之前
feature_encoders.md 36dd261d06 Add support for different encoder pinout for right half of split keyboard (#6521) 5 年之前
feature_grave_esc.md 3510d8dc8d Document an annoyance with Grave Escape and macOS Terminal (#5483) 6 年之前
feature_haptic_feedback.md 911b8915cc DRV2605L Continuous Haptic Feedback Support (#6461) 5 年之前
feature_hd44780.md d0ef139749 [Docs] Typo fix for feature_hd44780.md (#6917) 5 年之前
feature_key_lock.md 6560dffc05 update one shot keys link (#7020) 5 年之前
feature_layouts.md 40e67a3074 Add a mechanism for force building a particular community layout (#5027) 6 年之前
feature_leader_key.md afd5cda4a0 Fix up process_leader to be a bit more optimized (#4662) 6 年之前
feature_led_matrix.md 24df54b807 Add documentation for led matrix 6 年之前
feature_macros.md 9d97e47df4 [Docs] Update Super ALT↯TAB to remove use of unregister_code16 (#5766) 6 年之前
feature_mouse_keys.md 4856552f8b Update mouse keys docs (#5653) 6 年之前
feature_oled_driver.md 957070a6b5 Added OLED Display autoscroll during periods of OLED data inactivity (#6546) 5 年之前
feature_pointing_device.md af37bb2f78 Fix some of the more obvious typos 7 年之前
feature_ps2_mouse.md c73d6f6ac8 [Docs] Removed dead link (#6922) 5 年之前
feature_rgb_matrix.md 91ee6a1dbb [Docs] Add RGB Matrix default mode define info (#6564) 5 年之前
feature_rgblight.md 670a9b7f83 Add effect range to rgblight.c (#5856) 6 年之前
feature_space_cadet.md d16db69367 Added mod carry over from press to release. (#5866) 6 年之前
feature_split_keyboard.md 76378d74f5 ARM split - detect USB to select master/slave (#6424) 5 年之前
feature_stenography.md c0baf2a964 Improve state/chord handling and clean up namespace 7 年之前
feature_swap_hands.md fd085837e1 fix swap_hands keycodes in documentation (#3588) 6 年之前
feature_tap_dance.md 8da25dd6e3 [Docs] removed unneeded line of code in Tap Dance documentation (#6981) 5 年之前
feature_terminal.md 5112af887a Added command history to terminal with other bug fixes, added new song to song_list.h (#2855) 7 年之前
feature_thermal_printer.md 4c675a83ba Format keycode tables 7 年之前
feature_unicode.md ecf0612cc8 [Docs] Clarify the rules.mk setup for Unicode (#6286) 6 年之前
feature_userspace.md b62e160a89 Additional changes for Layer State typedef compatibility (#5906) 5 年之前
feature_velocikey.md c1c5922aae Velocikey: Match RGB animation speed to typing speed (#3754) 6 年之前
features.md dab4967f1b Add Dip Switch as a core feature (#6140) 5 年之前
flashing.md 17794e0b25 ARM split - Add support for dfu-util EE_HANDS flashing (#6543) 5 年之前
flashing_bootloadhid.md 51bcadf38c Add 'bootloadHID' flash target (#5587) 5 年之前
fuse.txt ca01d94005 convert docs to lowercase and underscores 8 年之前
getting_started_build_tools.md 4f2f2271cd Change from avr-gcc@7 to @8 for Mac 6 年之前
getting_started_getting_help.md 48913153c3 Replace gitter links with Discord. (#3368) 7 年之前
getting_started_github.md 76aa2baf3e Fix doc typo 6 年之前
getting_started_introduction.md d3317a8a66 [Docs] Update getting_started_introduction.md (#6037) 6 年之前
getting_started_make_guide.md 51bcadf38c Add 'bootloadHID' flash target (#5587) 5 年之前
getting_started_vagrant.md 29e9caa82b Configure Vagrant to use qmk_base_container (#6194) 6 年之前
hand_wire.md 53c51f1d16 A better new_project.sh (#5191) 6 年之前
hardware.md af37bb2f78 Fix some of the more obvious typos 7 年之前
hardware_avr.md ddaf37ffa9 Reword a note about the MANUFACTURER and PRODUCT defines in hardware_avr.md (#6558) 5 年之前
hardware_drivers.md 0a645225b9 OLED Driver Feature 6 年之前
hardware_keyboard_guidelines.md de386e5972 Fixed typos in documentation (#6871) 5 年之前
how_keyboards_work.md 129e4d1b2f [Docs] Update how_keyboards_work.md (#6528) 5 年之前
i2c_driver.md e6a6b1f122 [Docs] Update i2c_driver.md (#6665) 5 年之前
index.html 68072e931a Expose zh-cn docs, delete bad zh docs, add docs for adding translations (#6855) 5 年之前
internals_defines.md ae7284edb8 rename api docs to internals 7 年之前
internals_gpio_control.md 403c139b34 [Docs] Add AVR and ARM examples to GPIO Commands (#6942) 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 1dda671e4a ISP Flashing Guide - atmega32a info (#4993) 6 年之前
keycodes.md ad8dbd5ca5 ARM split - Add bootmagic/magic keycodes for setting handedness (#6545) 5 年之前
keycodes_basic.md ba05f9667b Add new brightness aliases to keycodes_basic.md 6 年之前
keycodes_us_ansi_shifted.md 9374c0c9db Add caveats for shifted characters (#4192) 6 年之前
keymap.md c534a4c775 [Docs] Smallish overhaul of the docs (#5281) 6 年之前
newbs.md efe360464d Contribute the MechMerlin QMK Configurator docs (#4986) 6 年之前
newbs_best_practices.md 480651cf9d Docs: Adding QMK Git Conventions doc; formatting cleanup on Learning Resources doc (#3902) 6 年之前
newbs_building_firmware.md 49fdd386b2 [Docs] Clean up docs/newbs_building_firmware.md (#6930) 5 年之前
newbs_building_firmware_configurator.md c806103f41 Update YouTube URL 5 年之前
newbs_flashing.md 1c07d4e7ef [Docs] Clean up docs/newbs_flashing.md (#6973) 5 年之前
newbs_getting_started.md 161d469f2c [Docs] Recursively clone qmk_firmware repo (#5378) 6 年之前
newbs_learn_more_resources.md 480651cf9d Docs: Adding QMK Git Conventions doc; formatting cleanup on Learning Resources doc (#3902) 6 年之前
newbs_testing_debugging.md feb116c4f3 [Docs] Replace Switch Hitter link with Wayback Machine link (#7009) 5 年之前
other_eclipse.md e9ace14878 [Docs] Add VSCode guide to docs (#5124) 6 年之前
other_vscode.md e9ace14878 [Docs] Add VSCode guide to docs (#5124) 6 年之前
porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md 4d72aa428f Improve backlight PWM pin support (#6202) 5 年之前
power.txt bb53635f33 Trim trailing whitespace 7 年之前
proton_c_conversion.md 3cf179be61 Adds Proton C Conversion (#4661) 6 年之前
qmk.css ccc87421e7 Some more tweaks to make everything look nice 7 年之前
quantum_keycodes.md c6184d2e7e Added check for event pressed to clear space cadet (#5839) 6 年之前
redirects.json d569f08771 Configuration system for CLI (#6708) 5 年之前
ref_functions.md b62e160a89 Additional changes for Layer State typedef compatibility (#5906) 5 年之前
reference_configurator_support.md 9cc5841a91 Update reference_configurator_support.md 6 年之前
reference_glossary.md dad79cafcd Fix more broken links to the HID spec 6 年之前
reference_info_json.md bcb1815420 Add label to the info.json reference 6 年之前
sidebar.css 7d49a17781 override hamburger placement 7 年之前
support.md 2ad2b73d68 Add support for PR and Issue templates to QMK_firmware GitHub (#4494) 6 年之前
sw.js 303f425c6b Fix up info boxes. 7 年之前
translating.md 68072e931a Expose zh-cn docs, delete bad zh docs, add docs for adding translations (#6855) 5 年之前
understanding_qmk.md c534a4c775 [Docs] Smallish overhaul of the docs (#5281) 6 年之前
unit_testing.md bb53635f33 Trim trailing whitespace 7 年之前
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores 8 年之前

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 that maintains QMK Firmware, QMK Toolbox, qmk.fm, and these docs. QMK Firmware is a keyboard firmware based on the tmk_keyboard with some useful features for Atmel AVR controllers, and more specifically, the OLKB product line, the ErgoDox EZ keyboard, and the Clueboard product line. It has also been ported to ARM chips using ChibiOS. You can use it to power your own hand-wired or custom keyboard PCB.

How to Get It

If you plan on contributing a keymap, keyboard, or features to QMK, the easiest thing to do is fork the repo through Github, and clone your repo locally to make your changes, push them, then open a Pull Request from your fork.

Otherwise, you can either download it directly (zip, tar), or clone it via git (git@github.com:qmk/qmk_firmware.git), or https (https://github.com/qmk/qmk_firmware.git).

How to Compile

Before you are able to compile, you'll need to install an environment for AVR or/and ARM development. Once that is complete, you'll use the make command to build a keyboard and keymap with the following notation:

make planck/rev4:default

This would build the rev4 revision of the planck with the default keymap. Not all keyboards have revisions (also called subprojects or folders), in which case, it can be omitted:

make preonic:default

How to Customize

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.