Эхлэл Бүгдийг харах Тусламж
Бүртгүүлэх Нэвтрэх
HuiJun
/
qmk_firmware
1
0
Салаа 0
Файлууд Асуудлууд 0 Хуулах хүсэлтүүд 0 Мэдлэгийн сан
Мод: 26a823082b
Салаанууд Тагууд
qmk_firmware
/
docs
Takeshi ISHII 26a823082b [Docs] Fix minor differences in docs/newbs_git_resynchronize_a_branch.md (#7728) 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 52c18ef026 [Docs] fix docs (#7642) 5 жил өмнө
ja 80e73b6210 [Docs] Update Japanese translation (#7693) 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 a8320f20f7 Improve support and docs for ADC driver (#7191) 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 0e96068d23 Update the breaking changes process so we always have a future branch (#6785) 5 жил өмнө
cli.md 897888db41 Add CLI command for flashing a keyboard 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 f275ffbdfc Minor grammar and filename fixes in docs (#7559) 5 жил өмнө
compatible_microcontrollers.md 5414ff709f [Doc] Tidy up compatible MCUs docs (#7295) 5 жил өмнө
config_options.md 60e4921378 Unify RGB and RGBW commands (#7297) 5 жил өмнө
contributing.md 3c190f8927 Improve docs "Edit Document" footer 5 жил өмнө
custom_quantum_functions.md 3541f01a72 Update led_update_kb example (#7451) 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 жил өмнө
faq.md e6c638bed1 Overhaul the Getting Started section and add a FAQ section 7 жил өмнө
faq_build.md 071eb2478f Remove mbed files (#7605) 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 e676278474 fix instructions for oneshot layer handling on key release (#7554) 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) 6 жил өмнө
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 be6562a223 Adds raw write functions to the OLED driver (#7237) 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 f275ffbdfc Minor grammar and filename fixes in docs (#7559) 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) 6 жил өмнө
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 5edd4b99fe [Docs] Encourage newbs to not download the repo as a zip (#7353) 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 380e05ad6e Update getting_started_make_guide.md (#7538) 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 1ea0cac998 ARM - ws2812 bitbang (#7173) 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 3ad389de55 Add short aliases for Magic keycodes (#7541) 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 49fdd386b2 [Docs] Clean up docs/newbs_building_firmware.md (#6930) 5 жил өмнө
newbs_building_firmware_configurator.md c806103f41 Update YouTube URL 6 жил өмнө
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 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 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 1ea0cac998 ARM - ws2812 bitbang (#7173) 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.