ホーム エクスプローラ ヘルプ
登録 サインイン
HuiJun
/
qmk_firmware
1
0
フォーク 0
ファイル 課題 0 プルリクエスト 0 Wiki
ツリー: 4a208b8951
ブランチ タグ
qmk_firmware
/
docs
shela ee88feb759 [Docs] Update Japanese translation (#8015) 5 年 前
..
ChangeLog d217307747 consistency 5 年 前
de 170261328e Add language prefixes to docs sidebar entries and readmes (#7406) 5 年 前
es 170261328e Add language prefixes to docs sidebar entries and readmes (#7406) 5 年 前
fr-fr 52c18ef026 [Docs] fix docs (#7642) 5 年 前
gitbook 4580d3a730 RGB improvements (#1684) 7 年 前
he-il c7b2d60a23 Move Space Cadet keycodes to their own section in keycode reference (#7889) 5 年 前
ja ee88feb759 [Docs] Update Japanese translation (#8015) 5 年 前
pt-br 10e8ed7430 [Docs] add README translation in portuguese (#7016) 5 年 前
ru-ru 52c18ef026 [Docs] fix docs (#7642) 5 年 前
zh-cn b359830ea2 Fix file encoding for zh-cn/custom_quantum_functions.md (#7665) 5 年 前
.nojekyll 9e5676650e Use docsfy to replace gitbook 7 年 前
CNAME 4d26137e2a Create CNAME 7 年 前
README.md 5edd4b99fe [Docs] Encourage newbs to not download the repo as a zip (#7353) 5 年 前
_langs.md 10e8ed7430 [Docs] add README translation in portuguese (#7016) 5 年 前
_summary.md d0d106cef7 change Instructions listing in Docs summary 5 年 前
adc_driver.md a8320f20f7 Improve support and docs for ADC driver (#7191) 5 年 前
arm_debugging.md 52c18ef026 [Docs] fix docs (#7642) 5 年 前
becoming_a_qmk_collaborator.md 1acaf2b2c2 Tweak the wording in "Becoming a QMK Collaborator" 6 年 前
breaking_changes.md 71de09d751 Update Breaking Changes doc timeline 5 年 前
breaking_changes_instructions.md 72d7661b30 suggestions by skullydazed 5 年 前
cli.md 5e65af3a76 Beef up how `qmk doctor` works. (#7375) 5 年 前
cli_configuration.md d569f08771 Configuration system for CLI (#6708) 5 年 前
cli_development.md f7bdc54c69 Add flake8 to our test suite and fix all errors (#7379) 5 年 前
coding_conventions_c.md f275ffbdfc Minor grammar and filename fixes in docs (#7559) 5 年 前
coding_conventions_python.md 58d27cf404 Add a note explaining how to run tests 5 年 前
compatible_microcontrollers.md 5414ff709f [Doc] Tidy up compatible MCUs docs (#7295) 5 年 前
config_options.md 95c24bbaf8 Implement and document TAPPING_FORCE_HOLD_PER_KEY (#7859) 5 年 前
contributing.md 3c190f8927 Improve docs "Edit Document" footer 5 年 前
custom_matrix.md 6e710426a4 Add docs for 'CUSTOM_MATRIX = lite' (#7906) 5 年 前
custom_quantum_functions.md 7f388b6553 Add per-key IGNORE_MOD_TAP_INTERRUPT feature (#7838) 5 年 前
documentation_best_practices.md 303f425c6b Fix up info boxes. 7 年 前
documentation_templates.md 7b6c8e89ca Doc fix to conform with #7221 (#7392) 5 年 前
driver_installation_zadig.md 80ded60cad Add a short explanation to Zadig the troubleshooting section (#7110) 5 年 前
eeprom_driver.md d13ada1162 Add customisable EEPROM driver selection (#7274) 5 年 前
faq.md e6c638bed1 Overhaul the Getting Started section and add a FAQ section 7 年 前
faq_build.md a52e55ec09 [Docs] Update macOS related issues in docs (#7744) 5 年 前
faq_debug.md 770a4ee729 [Docs] Remove some outdated FAQ items (#7607) 5 年 前
faq_general.md 5bb3fe7a35 Remove unanswered/unnecessary FAQ item 5 年 前
faq_keymap.md 770a4ee729 [Docs] Remove some outdated FAQ items (#7607) 5 年 前
feature_advanced_keycodes.md 95c24bbaf8 Implement and document TAPPING_FORCE_HOLD_PER_KEY (#7859) 5 年 前
feature_audio.md d534c72a54 Added keycodes for swapping and unswapping the Control and OS keys (#6110) 5 年 前
feature_auto_shift.md e9c44e396d Smallish overhaul of Auto-Shift feature (#6067) 5 年 前
feature_backlight.md 3d54b1adf0 Convert backlight to follow driver rules pattern - update docs 5 年 前
feature_bluetooth.md 908aede957 Update feature_bluetooth.md (#7193) 5 年 前
feature_bootmagic.md 3ad389de55 Add short aliases for Magic keycodes (#7541) 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 872744f5ab Update debounce docs (#7355) 5 年 前
feature_dip_switch.md dab4967f1b Add Dip Switch as a core feature (#6140) 5 年 前
feature_dynamic_macros.md 542cb0a8ce [Core] Convert Dynamic Macro to a Core Feature (#5948) 5 年 前
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 f275ffbdfc Minor grammar and filename fixes in docs (#7559) 5 年 前
feature_hd44780.md b23f6011c3 Remove build option firmware size impacts (#6947) 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 5a6737a778 Send string keycode tweaks (#7471) 5 年 前
feature_led_matrix.md 24df54b807 Add documentation for led matrix 6 年 前
feature_macros.md 5a6737a778 Send string keycode tweaks (#7471) 5 年 前
feature_mouse_keys.md 4856552f8b Update mouse keys docs (#5653) 6 年 前
feature_oled_driver.md 31c0fe69f6 [Docs] Misc cleanups for OLED documentation (#7864) 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 a1452db98a Configuration values for starting HSV and speed (#7740) 5 年 前
feature_rgblight.md f9521ffa21 Add shift-to-invert to remaining directional RGB_* keycode pairs (#7484) 5 年 前
feature_space_cadet.md d16db69367 Added mod carry over from press to release. (#5866) 6 年 前
feature_split_keyboard.md 1971f22285 Update split i2c docs for example of when pull-ups are required (#7143) 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 634b277b07 [Docs] Explain Tap Dance interruption (#5520) 5 年 前
feature_terminal.md b23f6011c3 Remove build option firmware size impacts (#6947) 5 年 前
feature_thermal_printer.md 4c675a83ba Format keycode tables 7 年 前
feature_unicode.md ecf0612cc8 [Docs] Clarify the rules.mk setup for Unicode (#6286) 5 年 前
feature_userspace.md 5a6737a778 Send string keycode tweaks (#7471) 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 0e6f78547e [Docs] Update flashing information to include :flash target (#6999) 5 年 前
flashing_bootloadhid.md 235da6973d Install bootloadHid as part of qmk_install (#7463) 5 年 前
fuse.txt ca01d94005 convert docs to lowercase and underscores 8 年 前
getting_started_build_tools.md 5a02cc00a4 Fix docker script and document (#7786) 5 年 前
getting_started_getting_help.md 48913153c3 Replace gitter links with Discord. (#3368) 7 年 前
getting_started_github.md 52c18ef026 [Docs] fix docs (#7642) 5 年 前
getting_started_introduction.md 09c7304bd9 [Docs] update git command and directory name of documents (#7619) 5 年 前
getting_started_make_guide.md 6e710426a4 Add docs for 'CUSTOM_MATRIX = lite' (#7906) 5 年 前
getting_started_vagrant.md dfdd9e821b [Docs] Update getting_started_vagrant.md (#7203) 5 年 前
hand_wire.md 19f73483d8 [Docs] Fixed internal links on Handwire page (#7154) 5 年 前
hardware.md af37bb2f78 Fix some of the more obvious typos 7 年 前
hardware_avr.md f87908228a Remove apostrophe from various abbreviations' plural forms (#7050) 5 年 前
hardware_drivers.md d13ada1162 Add customisable EEPROM driver selection (#7274) 5 年 前
hardware_keyboard_guidelines.md de386e5972 Fixed typos in documentation (#6871) 5 年 前
how_keyboards_work.md d5316e9714 Update URL for `60-keyboard.hwdb` (#7185) 5 年 前
i2c_driver.md e6a6b1f122 [Docs] Update i2c_driver.md (#6665) 5 年 前
index.html 3c190f8927 Improve docs "Edit Document" footer 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 c7b2d60a23 Move Space Cadet keycodes to their own section in keycode reference (#7889) 5 年 前
keycodes_basic.md 606813b72d Remove obsolete note about media keys in MacOS (#6631) 5 年 前
keycodes_us_ansi_shifted.md 40de65eac4 Backslash-escape pipe character in keycode lists (#7157) 5 年 前
keymap.md c534a4c775 [Docs] Smallish overhaul of the docs (#5281) 6 年 前
newbs.md b54722cc63 Change newbs.md to link to the new newbs_git_best_practices.md instead of newbs_best_practices.md. (#7633) 5 年 前
newbs_building_firmware.md dd04079098 Fixed a small typo (#7743) 5 年 前
newbs_building_firmware_configurator.md c806103f41 Update YouTube URL 5 年 前
newbs_flashing.md 0e6f78547e [Docs] Update flashing information to include :flash target (#6999) 5 年 前
newbs_getting_started.md 161d469f2c [Docs] Recursively clone qmk_firmware repo (#5378) 6 年 前
newbs_git_best_practices.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) 5 年 前
newbs_git_resolving_merge_conflicts.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) 5 年 前
newbs_git_resynchronize_a_branch.md 26a823082b [Docs] Fix minor differences in docs/newbs_git_resynchronize_a_branch.md (#7728) 5 年 前
newbs_git_using_your_master_branch.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) 5 年 前
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 1af31a0523 Update feature support for Proton C (#7596) 5 年 前
qmk.css ccc87421e7 Some more tweaks to make everything look nice 7 年 前
quantum_keycodes.md c7b2d60a23 Move Space Cadet keycodes to their own section in keycode reference (#7889) 5 年 前
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 f87908228a Remove apostrophe from various abbreviations' plural forms (#7050) 5 年 前
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 7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) 5 年 前
understanding_qmk.md f87908228a Remove apostrophe from various abbreviations' plural forms (#7050) 5 年 前
unit_testing.md bb53635f33 Trim trailing whitespace 7 年 前
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores 8 年 前
ws2812_driver.md 680ebef086 SPI DMA based RGB Underglow for STM32 (#7674) 5 年 前

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 clone it directly with git clone https://github.com/qmk/qmk_firmware. Do not download the zip or tar files; a git repository is required to download the submodules in order to compile.

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.