Etusivu Tutki Apua
Kirjaudu sisään
cinaeco
/
qmk_firmware
1
0
Fork 0
Tiedostot Ongelmat 0 Pull-pyynnöt 0 Wiki
Puu: 8030c17d63
Haarat Tagit
qmk_firmware
/
docs
fauxpark 3ad389de55 Add short aliases for Magic keycodes (#7541) 6 vuotta sitten
..
ChangeLog d217307747 consistency 7 vuotta sitten
de 170261328e Add language prefixes to docs sidebar entries and readmes (#7406) 6 vuotta sitten
es 170261328e Add language prefixes to docs sidebar entries and readmes (#7406) 6 vuotta sitten
fr-fr 170261328e Add language prefixes to docs sidebar entries and readmes (#7406) 6 vuotta sitten
gitbook 4580d3a730 RGB improvements (#1684) 9 vuotta sitten
he-il 170261328e Add language prefixes to docs sidebar entries and readmes (#7406) 6 vuotta sitten
ja da1a527c90 [Docs] add japanese translations (#7454) 6 vuotta sitten
ru-ru f099142004 Add _summary.md for Russian docs with proper language prefix (#7514) 6 vuotta sitten
zh-cn 170261328e Add language prefixes to docs sidebar entries and readmes (#7406) 6 vuotta sitten
.nojekyll 9e5676650e Use docsfy to replace gitbook 8 vuotta sitten
CNAME 4d26137e2a Create CNAME 8 vuotta sitten
README.md 5edd4b99fe [Docs] Encourage newbs to not download the repo as a zip (#7353) 6 vuotta sitten
_langs.md 23f828a2f3 [Docs] Fix Japanese country flag (#7407) 6 vuotta sitten
_summary.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) 6 vuotta sitten
arm_debugging.md de386e5972 Fixed typos in documentation (#6871) 6 vuotta sitten
becoming_a_qmk_collaborator.md 1acaf2b2c2 Tweak the wording in "Becoming a QMK Collaborator" 8 vuotta sitten
breaking_changes.md 0e96068d23 Update the breaking changes process so we always have a future branch (#6785) 7 vuotta sitten
cli.md 897888db41 Add CLI command for flashing a keyboard 6 vuotta sitten
cli_configuration.md d569f08771 Configuration system for CLI (#6708) 7 vuotta sitten
cli_development.md f7bdc54c69 Add flake8 to our test suite and fix all errors (#7379) 6 vuotta sitten
coding_conventions_c.md 22cc56bc97 [Docs] Fix incorrect spacing on Coding Conventions page (#7058) 6 vuotta sitten
coding_conventions_python.md 6a75d10979 [Docs] Fix dunder names being accidentally bolded (#7217) 6 vuotta sitten
compatible_microcontrollers.md 5414ff709f [Doc] Tidy up compatible MCUs docs (#7295) 6 vuotta sitten
config_options.md 60e4921378 Unify RGB and RGBW commands (#7297) 6 vuotta sitten
contributing.md 9ea9806d67 Set up language fallback for docs, and update translation guidelines (#7403) 6 vuotta sitten
custom_quantum_functions.md 3541f01a72 Update led_update_kb example (#7451) 6 vuotta sitten
documentation_best_practices.md 303f425c6b Fix up info boxes. 8 vuotta sitten
documentation_templates.md 7b6c8e89ca Doc fix to conform with #7221 (#7392) 6 vuotta sitten
driver_installation_zadig.md 80ded60cad Add a short explanation to Zadig the troubleshooting section (#7110) 6 vuotta sitten
faq.md e6c638bed1 Overhaul the Getting Started section and add a FAQ section 9 vuotta sitten
faq_build.md 235da6973d Install bootloadHid as part of qmk_install (#7463) 6 vuotta sitten
faq_debug.md cee8df3edf [Docs] Modified the description about setting debug_enable in `docs/faq_debug.md`. (#7394) 6 vuotta sitten
faq_general.md 5bb3fe7a35 Remove unanswered/unnecessary FAQ item 6 vuotta sitten
faq_keymap.md 606813b72d Remove obsolete note about media keys in MacOS (#6631) 6 vuotta sitten
feature_advanced_keycodes.md 3b9a139c07 fix feature_advanced_keycodes.md's link (#7421) 6 vuotta sitten
feature_audio.md d534c72a54 Added keycodes for swapping and unswapping the Control and OS keys (#6110) 7 vuotta sitten
feature_auto_shift.md e9c44e396d Smallish overhaul of Auto-Shift feature (#6067) 6 vuotta sitten
feature_backlight.md 4531cc874e Initial migration of software PWM backlight (#6709) 6 vuotta sitten
feature_bluetooth.md 908aede957 Update feature_bluetooth.md (#7193) 6 vuotta sitten
feature_bootmagic.md 3ad389de55 Add short aliases for Magic keycodes (#7541) 6 vuotta sitten
feature_combo.md 57540af102 Change "yu" to "you" in combo docs (#6510) 7 vuotta sitten
feature_command.md a2e91ebec9 Update IS_COMMAND definitions to use MOD_MASK_SHIFT (#6348) 7 vuotta sitten
feature_debounce_type.md 872744f5ab Update debounce docs (#7355) 6 vuotta sitten
feature_dip_switch.md dab4967f1b Add Dip Switch as a core feature (#6140) 7 vuotta sitten
feature_dynamic_macros.md 542cb0a8ce [Core] Convert Dynamic Macro to a Core Feature (#5948) 6 vuotta sitten
feature_encoders.md 36dd261d06 Add support for different encoder pinout for right half of split keyboard (#6521) 7 vuotta sitten
feature_grave_esc.md 3510d8dc8d Document an annoyance with Grave Escape and macOS Terminal (#5483) 7 vuotta sitten
feature_haptic_feedback.md f6b5f6db76 Improvements to Solenoid feature (#7369) 6 vuotta sitten
feature_hd44780.md b23f6011c3 Remove build option firmware size impacts (#6947) 6 vuotta sitten
feature_key_lock.md 6560dffc05 update one shot keys link (#7020) 6 vuotta sitten
feature_layouts.md 40e67a3074 Add a mechanism for force building a particular community layout (#5027) 7 vuotta sitten
feature_leader_key.md 5a6737a778 Send string keycode tweaks (#7471) 6 vuotta sitten
feature_led_matrix.md 24df54b807 Add documentation for led matrix 7 vuotta sitten
feature_macros.md 5a6737a778 Send string keycode tweaks (#7471) 6 vuotta sitten
feature_mouse_keys.md 4856552f8b Update mouse keys docs (#5653) 7 vuotta sitten
feature_oled_driver.md be6562a223 Adds raw write functions to the OLED driver (#7237) 6 vuotta sitten
feature_pointing_device.md af37bb2f78 Fix some of the more obvious typos 8 vuotta sitten
feature_ps2_mouse.md c73d6f6ac8 [Docs] Removed dead link (#6922) 6 vuotta sitten
feature_rgb_matrix.md f9521ffa21 Add shift-to-invert to remaining directional RGB_* keycode pairs (#7484) 6 vuotta sitten
feature_rgblight.md f9521ffa21 Add shift-to-invert to remaining directional RGB_* keycode pairs (#7484) 6 vuotta sitten
feature_space_cadet.md d16db69367 Added mod carry over from press to release. (#5866) 7 vuotta sitten
feature_split_keyboard.md 1971f22285 Update split i2c docs for example of when pull-ups are required (#7143) 6 vuotta sitten
feature_stenography.md c0baf2a964 Improve state/chord handling and clean up namespace 8 vuotta sitten
feature_swap_hands.md fd085837e1 fix swap_hands keycodes in documentation (#3588) 8 vuotta sitten
feature_tap_dance.md 634b277b07 [Docs] Explain Tap Dance interruption (#5520) 6 vuotta sitten
feature_terminal.md b23f6011c3 Remove build option firmware size impacts (#6947) 6 vuotta sitten
feature_thermal_printer.md 4c675a83ba Format keycode tables 8 vuotta sitten
feature_unicode.md ecf0612cc8 [Docs] Clarify the rules.mk setup for Unicode (#6286) 7 vuotta sitten
feature_userspace.md 5a6737a778 Send string keycode tweaks (#7471) 6 vuotta sitten
feature_velocikey.md c1c5922aae Velocikey: Match RGB animation speed to typing speed (#3754) 7 vuotta sitten
features.md dab4967f1b Add Dip Switch as a core feature (#6140) 7 vuotta sitten
flashing.md 0e6f78547e [Docs] Update flashing information to include :flash target (#6999) 6 vuotta sitten
flashing_bootloadhid.md 235da6973d Install bootloadHid as part of qmk_install (#7463) 6 vuotta sitten
fuse.txt ca01d94005 convert docs to lowercase and underscores 9 vuotta sitten
getting_started_build_tools.md 5edd4b99fe [Docs] Encourage newbs to not download the repo as a zip (#7353) 6 vuotta sitten
getting_started_getting_help.md 48913153c3 Replace gitter links with Discord. (#3368) 8 vuotta sitten
getting_started_github.md 76aa2baf3e Fix doc typo 7 vuotta sitten
getting_started_introduction.md d3317a8a66 [Docs] Update getting_started_introduction.md (#6037) 7 vuotta sitten
getting_started_make_guide.md 0e6f78547e [Docs] Update flashing information to include :flash target (#6999) 6 vuotta sitten
getting_started_vagrant.md dfdd9e821b [Docs] Update getting_started_vagrant.md (#7203) 6 vuotta sitten
hand_wire.md 19f73483d8 [Docs] Fixed internal links on Handwire page (#7154) 6 vuotta sitten
hardware.md af37bb2f78 Fix some of the more obvious typos 8 vuotta sitten
hardware_avr.md f87908228a Remove apostrophe from various abbreviations' plural forms (#7050) 6 vuotta sitten
hardware_drivers.md 1ea0cac998 ARM - ws2812 bitbang (#7173) 6 vuotta sitten
hardware_keyboard_guidelines.md de386e5972 Fixed typos in documentation (#6871) 6 vuotta sitten
how_keyboards_work.md d5316e9714 Update URL for `60-keyboard.hwdb` (#7185) 6 vuotta sitten
i2c_driver.md e6a6b1f122 [Docs] Update i2c_driver.md (#6665) 7 vuotta sitten
index.html 7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) 6 vuotta sitten
internals_defines.md ae7284edb8 rename api docs to internals 8 vuotta sitten
internals_gpio_control.md 403c139b34 [Docs] Add AVR and ARM examples to GPIO Commands (#6942) 6 vuotta sitten
internals_input_callback_reg.md ae7284edb8 rename api docs to internals 8 vuotta sitten
internals_midi_device.md ae7284edb8 rename api docs to internals 8 vuotta sitten
internals_midi_device_setup_process.md ae7284edb8 rename api docs to internals 8 vuotta sitten
internals_midi_util.md ae7284edb8 rename api docs to internals 8 vuotta sitten
internals_send_functions.md ae7284edb8 rename api docs to internals 8 vuotta sitten
internals_sysex_tools.md ae7284edb8 rename api docs to internals 8 vuotta sitten
isp_flashing_guide.md 1dda671e4a ISP Flashing Guide - atmega32a info (#4993) 7 vuotta sitten
keycodes.md 3ad389de55 Add short aliases for Magic keycodes (#7541) 6 vuotta sitten
keycodes_basic.md 606813b72d Remove obsolete note about media keys in MacOS (#6631) 6 vuotta sitten
keycodes_us_ansi_shifted.md 40de65eac4 Backslash-escape pipe character in keycode lists (#7157) 6 vuotta sitten
keymap.md c534a4c775 [Docs] Smallish overhaul of the docs (#5281) 7 vuotta sitten
newbs.md efe360464d Contribute the MechMerlin QMK Configurator docs (#4986) 7 vuotta sitten
newbs_building_firmware.md 49fdd386b2 [Docs] Clean up docs/newbs_building_firmware.md (#6930) 6 vuotta sitten
newbs_building_firmware_configurator.md c806103f41 Update YouTube URL 7 vuotta sitten
newbs_flashing.md 0e6f78547e [Docs] Update flashing information to include :flash target (#6999) 6 vuotta sitten
newbs_getting_started.md 161d469f2c [Docs] Recursively clone qmk_firmware repo (#5378) 7 vuotta sitten
newbs_git_best_practices.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) 6 vuotta sitten
newbs_git_resolving_merge_conflicts.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) 6 vuotta sitten
newbs_git_resynchronize_a_branch.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) 6 vuotta sitten
newbs_git_using_your_master_branch.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) 6 vuotta sitten
newbs_learn_more_resources.md 480651cf9d Docs: Adding QMK Git Conventions doc; formatting cleanup on Learning Resources doc (#3902) 7 vuotta sitten
newbs_testing_debugging.md feb116c4f3 [Docs] Replace Switch Hitter link with Wayback Machine link (#7009) 6 vuotta sitten
other_eclipse.md e9ace14878 [Docs] Add VSCode guide to docs (#5124) 7 vuotta sitten
other_vscode.md e9ace14878 [Docs] Add VSCode guide to docs (#5124) 7 vuotta sitten
porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md 4d72aa428f Improve backlight PWM pin support (#6202) 7 vuotta sitten
power.txt bb53635f33 Trim trailing whitespace 8 vuotta sitten
proton_c_conversion.md 1249da4e8e Use task driven PWM for CTPC until ARM can provide automatic configuration (#6928) 6 vuotta sitten
qmk.css ccc87421e7 Some more tweaks to make everything look nice 8 vuotta sitten
quantum_keycodes.md c6184d2e7e Added check for event pressed to clear space cadet (#5839) 7 vuotta sitten
redirects.json d569f08771 Configuration system for CLI (#6708) 7 vuotta sitten
ref_functions.md b62e160a89 Additional changes for Layer State typedef compatibility (#5906) 7 vuotta sitten
reference_configurator_support.md 9cc5841a91 Update reference_configurator_support.md 7 vuotta sitten
reference_glossary.md f87908228a Remove apostrophe from various abbreviations' plural forms (#7050) 6 vuotta sitten
reference_info_json.md bcb1815420 Add label to the info.json reference 7 vuotta sitten
sidebar.css 7d49a17781 override hamburger placement 8 vuotta sitten
support.md 2ad2b73d68 Add support for PR and Issue templates to QMK_firmware GitHub (#4494) 7 vuotta sitten
sw.js 303f425c6b Fix up info boxes. 8 vuotta sitten
translating.md 7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) 6 vuotta sitten
understanding_qmk.md f87908228a Remove apostrophe from various abbreviations' plural forms (#7050) 6 vuotta sitten
unit_testing.md bb53635f33 Trim trailing whitespace 8 vuotta sitten
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores 9 vuotta sitten
ws2812_driver.md 1ea0cac998 ARM - ws2812 bitbang (#7173) 6 vuotta sitten

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.