Startseite Erkunden Hilfe
Anmelden
cinaeco
/
qmk_firmware
1
0
Fork 0
Dateien Issues 0 Pull-Requests 0 Wiki
Struktur: b69b1ad4fc
Branches Tags
qmk_firmware
/
docs
skullY 58d27cf404 Add a note explaining how to run tests vor 6 Jahren
..
ChangeLog d217307747 consistency vor 6 Jahren
de 170261328e Add language prefixes to docs sidebar entries and readmes (#7406) vor 6 Jahren
es 170261328e Add language prefixes to docs sidebar entries and readmes (#7406) vor 6 Jahren
fr-fr 52c18ef026 [Docs] fix docs (#7642) vor 6 Jahren
gitbook 4580d3a730 RGB improvements (#1684) vor 8 Jahren
he-il c7b2d60a23 Move Space Cadet keycodes to their own section in keycode reference (#7889) vor 6 Jahren
ja 7f388b6553 Add per-key IGNORE_MOD_TAP_INTERRUPT feature (#7838) vor 6 Jahren
pt-br 10e8ed7430 [Docs] add README translation in portuguese (#7016) vor 6 Jahren
ru-ru 52c18ef026 [Docs] fix docs (#7642) vor 6 Jahren
zh-cn b359830ea2 Fix file encoding for zh-cn/custom_quantum_functions.md (#7665) vor 6 Jahren
.nojekyll 9e5676650e Use docsfy to replace gitbook vor 8 Jahren
CNAME 4d26137e2a Create CNAME vor 8 Jahren
README.md 5edd4b99fe [Docs] Encourage newbs to not download the repo as a zip (#7353) vor 6 Jahren
_langs.md 10e8ed7430 [Docs] add README translation in portuguese (#7016) vor 6 Jahren
_summary.md a8320f20f7 Improve support and docs for ADC driver (#7191) vor 6 Jahren
adc_driver.md a8320f20f7 Improve support and docs for ADC driver (#7191) vor 6 Jahren
arm_debugging.md 52c18ef026 [Docs] fix docs (#7642) vor 6 Jahren
becoming_a_qmk_collaborator.md 1acaf2b2c2 Tweak the wording in "Becoming a QMK Collaborator" vor 7 Jahren
breaking_changes.md 71de09d751 Update Breaking Changes doc timeline vor 6 Jahren
cli.md 897888db41 Add CLI command for flashing a keyboard vor 6 Jahren
cli_configuration.md d569f08771 Configuration system for CLI (#6708) vor 6 Jahren
cli_development.md f7bdc54c69 Add flake8 to our test suite and fix all errors (#7379) vor 6 Jahren
coding_conventions_c.md f275ffbdfc Minor grammar and filename fixes in docs (#7559) vor 6 Jahren
coding_conventions_python.md 58d27cf404 Add a note explaining how to run tests vor 6 Jahren
compatible_microcontrollers.md 5414ff709f [Doc] Tidy up compatible MCUs docs (#7295) vor 6 Jahren
config_options.md 7f388b6553 Add per-key IGNORE_MOD_TAP_INTERRUPT feature (#7838) vor 6 Jahren
contributing.md 3c190f8927 Improve docs "Edit Document" footer vor 6 Jahren
custom_quantum_functions.md 7f388b6553 Add per-key IGNORE_MOD_TAP_INTERRUPT feature (#7838) vor 6 Jahren
documentation_best_practices.md 303f425c6b Fix up info boxes. vor 8 Jahren
documentation_templates.md 7b6c8e89ca Doc fix to conform with #7221 (#7392) vor 6 Jahren
driver_installation_zadig.md 80ded60cad Add a short explanation to Zadig the troubleshooting section (#7110) vor 6 Jahren
faq.md e6c638bed1 Overhaul the Getting Started section and add a FAQ section vor 8 Jahren
faq_build.md a52e55ec09 [Docs] Update macOS related issues in docs (#7744) vor 6 Jahren
faq_debug.md 770a4ee729 [Docs] Remove some outdated FAQ items (#7607) vor 6 Jahren
faq_general.md 5bb3fe7a35 Remove unanswered/unnecessary FAQ item vor 6 Jahren
faq_keymap.md 770a4ee729 [Docs] Remove some outdated FAQ items (#7607) vor 6 Jahren
feature_advanced_keycodes.md e676278474 fix instructions for oneshot layer handling on key release (#7554) vor 6 Jahren
feature_audio.md d534c72a54 Added keycodes for swapping and unswapping the Control and OS keys (#6110) vor 6 Jahren
feature_auto_shift.md e9c44e396d Smallish overhaul of Auto-Shift feature (#6067) vor 6 Jahren
feature_backlight.md 3d54b1adf0 Convert backlight to follow driver rules pattern - update docs vor 6 Jahren
feature_bluetooth.md 908aede957 Update feature_bluetooth.md (#7193) vor 6 Jahren
feature_bootmagic.md 3ad389de55 Add short aliases for Magic keycodes (#7541) vor 6 Jahren
feature_combo.md 57540af102 Change "yu" to "you" in combo docs (#6510) vor 6 Jahren
feature_command.md a2e91ebec9 Update IS_COMMAND definitions to use MOD_MASK_SHIFT (#6348) vor 6 Jahren
feature_debounce_type.md 872744f5ab Update debounce docs (#7355) vor 6 Jahren
feature_dip_switch.md dab4967f1b Add Dip Switch as a core feature (#6140) vor 6 Jahren
feature_dynamic_macros.md 542cb0a8ce [Core] Convert Dynamic Macro to a Core Feature (#5948) vor 6 Jahren
feature_encoders.md 36dd261d06 Add support for different encoder pinout for right half of split keyboard (#6521) vor 6 Jahren
feature_grave_esc.md 3510d8dc8d Document an annoyance with Grave Escape and macOS Terminal (#5483) vor 7 Jahren
feature_haptic_feedback.md f275ffbdfc Minor grammar and filename fixes in docs (#7559) vor 6 Jahren
feature_hd44780.md b23f6011c3 Remove build option firmware size impacts (#6947) vor 6 Jahren
feature_key_lock.md 6560dffc05 update one shot keys link (#7020) vor 6 Jahren
feature_layouts.md 40e67a3074 Add a mechanism for force building a particular community layout (#5027) vor 7 Jahren
feature_leader_key.md 5a6737a778 Send string keycode tweaks (#7471) vor 6 Jahren
feature_led_matrix.md 24df54b807 Add documentation for led matrix vor 7 Jahren
feature_macros.md 5a6737a778 Send string keycode tweaks (#7471) vor 6 Jahren
feature_mouse_keys.md 4856552f8b Update mouse keys docs (#5653) vor 7 Jahren
feature_oled_driver.md be6562a223 Adds raw write functions to the OLED driver (#7237) vor 6 Jahren
feature_pointing_device.md af37bb2f78 Fix some of the more obvious typos vor 8 Jahren
feature_ps2_mouse.md c73d6f6ac8 [Docs] Removed dead link (#6922) vor 6 Jahren
feature_rgb_matrix.md cf30c5d17f RGB matrix effect - left-right gradient (#7742) vor 6 Jahren
feature_rgblight.md f9521ffa21 Add shift-to-invert to remaining directional RGB_* keycode pairs (#7484) vor 6 Jahren
feature_space_cadet.md d16db69367 Added mod carry over from press to release. (#5866) vor 7 Jahren
feature_split_keyboard.md 1971f22285 Update split i2c docs for example of when pull-ups are required (#7143) vor 6 Jahren
feature_stenography.md c0baf2a964 Improve state/chord handling and clean up namespace vor 8 Jahren
feature_swap_hands.md fd085837e1 fix swap_hands keycodes in documentation (#3588) vor 7 Jahren
feature_tap_dance.md 634b277b07 [Docs] Explain Tap Dance interruption (#5520) vor 6 Jahren
feature_terminal.md b23f6011c3 Remove build option firmware size impacts (#6947) vor 6 Jahren
feature_thermal_printer.md 4c675a83ba Format keycode tables vor 8 Jahren
feature_unicode.md ecf0612cc8 [Docs] Clarify the rules.mk setup for Unicode (#6286) vor 7 Jahren
feature_userspace.md 5a6737a778 Send string keycode tweaks (#7471) vor 6 Jahren
feature_velocikey.md c1c5922aae Velocikey: Match RGB animation speed to typing speed (#3754) vor 7 Jahren
features.md dab4967f1b Add Dip Switch as a core feature (#6140) vor 6 Jahren
flashing.md 0e6f78547e [Docs] Update flashing information to include :flash target (#6999) vor 6 Jahren
flashing_bootloadhid.md 235da6973d Install bootloadHid as part of qmk_install (#7463) vor 6 Jahren
fuse.txt ca01d94005 convert docs to lowercase and underscores vor 9 Jahren
getting_started_build_tools.md 5a02cc00a4 Fix docker script and document (#7786) vor 6 Jahren
getting_started_getting_help.md 48913153c3 Replace gitter links with Discord. (#3368) vor 8 Jahren
getting_started_github.md 52c18ef026 [Docs] fix docs (#7642) vor 6 Jahren
getting_started_introduction.md 09c7304bd9 [Docs] update git command and directory name of documents (#7619) vor 6 Jahren
getting_started_make_guide.md 380e05ad6e Update getting_started_make_guide.md (#7538) vor 6 Jahren
getting_started_vagrant.md dfdd9e821b [Docs] Update getting_started_vagrant.md (#7203) vor 6 Jahren
hand_wire.md 19f73483d8 [Docs] Fixed internal links on Handwire page (#7154) vor 6 Jahren
hardware.md af37bb2f78 Fix some of the more obvious typos vor 8 Jahren
hardware_avr.md f87908228a Remove apostrophe from various abbreviations' plural forms (#7050) vor 6 Jahren
hardware_drivers.md 1ea0cac998 ARM - ws2812 bitbang (#7173) vor 6 Jahren
hardware_keyboard_guidelines.md de386e5972 Fixed typos in documentation (#6871) vor 6 Jahren
how_keyboards_work.md d5316e9714 Update URL for `60-keyboard.hwdb` (#7185) vor 6 Jahren
i2c_driver.md e6a6b1f122 [Docs] Update i2c_driver.md (#6665) vor 6 Jahren
index.html 3c190f8927 Improve docs "Edit Document" footer vor 6 Jahren
internals_defines.md ae7284edb8 rename api docs to internals vor 8 Jahren
internals_gpio_control.md 403c139b34 [Docs] Add AVR and ARM examples to GPIO Commands (#6942) vor 6 Jahren
internals_input_callback_reg.md ae7284edb8 rename api docs to internals vor 8 Jahren
internals_midi_device.md ae7284edb8 rename api docs to internals vor 8 Jahren
internals_midi_device_setup_process.md ae7284edb8 rename api docs to internals vor 8 Jahren
internals_midi_util.md ae7284edb8 rename api docs to internals vor 8 Jahren
internals_send_functions.md ae7284edb8 rename api docs to internals vor 8 Jahren
internals_sysex_tools.md ae7284edb8 rename api docs to internals vor 8 Jahren
isp_flashing_guide.md 1dda671e4a ISP Flashing Guide - atmega32a info (#4993) vor 7 Jahren
keycodes.md c7b2d60a23 Move Space Cadet keycodes to their own section in keycode reference (#7889) vor 6 Jahren
keycodes_basic.md 606813b72d Remove obsolete note about media keys in MacOS (#6631) vor 6 Jahren
keycodes_us_ansi_shifted.md 40de65eac4 Backslash-escape pipe character in keycode lists (#7157) vor 6 Jahren
keymap.md c534a4c775 [Docs] Smallish overhaul of the docs (#5281) vor 7 Jahren
newbs.md b54722cc63 Change newbs.md to link to the new newbs_git_best_practices.md instead of newbs_best_practices.md. (#7633) vor 6 Jahren
newbs_building_firmware.md dd04079098 Fixed a small typo (#7743) vor 6 Jahren
newbs_building_firmware_configurator.md c806103f41 Update YouTube URL vor 6 Jahren
newbs_flashing.md 0e6f78547e [Docs] Update flashing information to include :flash target (#6999) vor 6 Jahren
newbs_getting_started.md 161d469f2c [Docs] Recursively clone qmk_firmware repo (#5378) vor 7 Jahren
newbs_git_best_practices.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) vor 6 Jahren
newbs_git_resolving_merge_conflicts.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) vor 6 Jahren
newbs_git_resynchronize_a_branch.md 26a823082b [Docs] Fix minor differences in docs/newbs_git_resynchronize_a_branch.md (#7728) vor 6 Jahren
newbs_git_using_your_master_branch.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) vor 6 Jahren
newbs_learn_more_resources.md 480651cf9d Docs: Adding QMK Git Conventions doc; formatting cleanup on Learning Resources doc (#3902) vor 7 Jahren
newbs_testing_debugging.md feb116c4f3 [Docs] Replace Switch Hitter link with Wayback Machine link (#7009) vor 6 Jahren
other_eclipse.md e9ace14878 [Docs] Add VSCode guide to docs (#5124) vor 7 Jahren
other_vscode.md e9ace14878 [Docs] Add VSCode guide to docs (#5124) vor 7 Jahren
porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md 4d72aa428f Improve backlight PWM pin support (#6202) vor 6 Jahren
power.txt bb53635f33 Trim trailing whitespace vor 8 Jahren
proton_c_conversion.md 1af31a0523 Update feature support for Proton C (#7596) vor 6 Jahren
qmk.css ccc87421e7 Some more tweaks to make everything look nice vor 8 Jahren
quantum_keycodes.md c7b2d60a23 Move Space Cadet keycodes to their own section in keycode reference (#7889) vor 6 Jahren
redirects.json d569f08771 Configuration system for CLI (#6708) vor 6 Jahren
ref_functions.md b62e160a89 Additional changes for Layer State typedef compatibility (#5906) vor 6 Jahren
reference_configurator_support.md 9cc5841a91 Update reference_configurator_support.md vor 7 Jahren
reference_glossary.md f87908228a Remove apostrophe from various abbreviations' plural forms (#7050) vor 6 Jahren
reference_info_json.md bcb1815420 Add label to the info.json reference vor 7 Jahren
sidebar.css 7d49a17781 override hamburger placement vor 8 Jahren
support.md 2ad2b73d68 Add support for PR and Issue templates to QMK_firmware GitHub (#4494) vor 7 Jahren
sw.js 303f425c6b Fix up info boxes. vor 8 Jahren
translating.md 7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) vor 6 Jahren
understanding_qmk.md f87908228a Remove apostrophe from various abbreviations' plural forms (#7050) vor 6 Jahren
unit_testing.md bb53635f33 Trim trailing whitespace vor 8 Jahren
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores vor 9 Jahren
ws2812_driver.md 680ebef086 SPI DMA based RGB Underglow for STM32 (#7674) vor 6 Jahren

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.