Etusivu Tutki Apua
Kirjaudu sisään
Tankernn
/
qmk_firmware
1
0
Haarauta 0
Tiedostot Esitykset 0 Vetopyynnöt 0 Wiki
Puu: a25dd58bc5
Haarat Tunnisteet
qmk_firmware
/
docs
skullydazed a25dd58bc5 QMK CLI and JSON keymap support (#6176) 6 vuotta sitten
..
gitbook 4580d3a730 RGB improvements (#1684) 8 vuotta sitten
zh 3cf179be61 Adds Proton C Conversion (#4661) 6 vuotta sitten
zh-cn 4f2f2271cd Change from avr-gcc@7 to @8 for Mac 6 vuotta sitten
.nojekyll 9e5676650e Use docsfy to replace gitbook 7 vuotta sitten
CNAME 4d26137e2a Create CNAME 7 vuotta sitten
LANGS.md d5a06aec83 Second try at configuring i18n for docsify and gitbook (#4531) 7 vuotta sitten
README.md 73ddb764cc Fix readme and contributing hyperlinks 7 vuotta sitten
_summary.md a25dd58bc5 QMK CLI and JSON keymap support (#6176) 6 vuotta sitten
arm_debugging.md ac7b2d92bf ARM SWD guide 7 vuotta sitten
becoming_a_qmk_collaborator.md 1acaf2b2c2 Tweak the wording in "Becoming a QMK Collaborator" 7 vuotta sitten
cli.md a25dd58bc5 QMK CLI and JSON keymap support (#6176) 6 vuotta sitten
coding_conventions_c.md a25dd58bc5 QMK CLI and JSON keymap support (#6176) 6 vuotta sitten
coding_conventions_python.md a25dd58bc5 QMK CLI and JSON keymap support (#6176) 6 vuotta sitten
compatible_microcontrollers.md 7b0356d1d4 Convert all headings to Title Case 8 vuotta sitten
config_options.md 317b809564 Fix breathing always on for soft PWM (#5983) 6 vuotta sitten
contributing.md a25dd58bc5 QMK CLI and JSON keymap support (#6176) 6 vuotta sitten
custom_quantum_functions.md e0a0d80bd3 docs to Mandarin Chinese (#5960) 6 vuotta sitten
documentation_best_practices.md 303f425c6b Fix up info boxes. 7 vuotta sitten
documentation_templates.md 8454fa5e9f Update Document Templates to reflect newer wording and URLs (#4006) 7 vuotta sitten
faq.md e6c638bed1 Overhaul the Getting Started section and add a FAQ section 8 vuotta sitten
faq_build.md 4f2f2271cd Change from avr-gcc@7 to @8 for Mac 6 vuotta sitten
faq_debug.md 4211252117 [Docs] Fix indented subheading on faq_debug.md (#6320) 6 vuotta sitten
faq_general.md 7b0356d1d4 Convert all headings to Title Case 8 vuotta sitten
faq_keymap.md 384fef72d3 Replace instances of KEYMAP with LAYOUT 6 vuotta sitten
feature_advanced_keycodes.md c1c0cf73ce fix typo 6 vuotta sitten
feature_audio.md d85110b6ec Adds a configurable initial delay to the audio clicky feature (#4286) 6 vuotta sitten
feature_auto_shift.md 303f425c6b Fix up info boxes. 7 vuotta sitten
feature_backlight.md 317b809564 Fix breathing always on for soft PWM (#5983) 6 vuotta sitten
feature_bluetooth.md 914d42acd0 Update Bluetooth docs (#4062) 7 vuotta sitten
feature_bootmagic.md faaaa134fd Replace DEBOUNCING_DELAY (deprecated) with DEBOUNCE (#5997) 6 vuotta sitten
feature_combo.md b2f7915994 [Docs] Make Code Examples Consistent On Combo Page (#6078) 6 vuotta sitten
feature_command.md 5cb713148d Change Command keycode defaults to match corresponding Bootmagic codes (#5078) 6 vuotta sitten
feature_debounce_type.md 17e7762de7 Eager Per Row Debouncing added (added to Ergodox) (#5498) 6 vuotta sitten
feature_dynamic_macros.md 6caea0acfb Docs: Adjust dynamic macro docs to include more than the planck (#3509) 7 vuotta sitten
feature_encoders.md 3ef425423a Update feature_encoders.md 6 vuotta sitten
feature_grave_esc.md 3510d8dc8d Document an annoyance with Grave Escape and macOS Terminal (#5483) 6 vuotta sitten
feature_haptic_feedback.md 2cee371bf1 Haptic feedback generalized - DRV2605 and solenoids (#4939) 6 vuotta sitten
feature_hd44780.md bbea9dadbc Integrating Peter Fleury's HD44780 LCD library (#3209) 7 vuotta sitten
feature_key_lock.md c11a26ba54 Docs: Format Key Lock documentation (#3538) 7 vuotta sitten
feature_layouts.md 40e67a3074 Add a mechanism for force building a particular community layout (#5027) 6 vuotta sitten
feature_leader_key.md afd5cda4a0 Fix up process_leader to be a bit more optimized (#4662) 7 vuotta sitten
feature_led_matrix.md 24df54b807 Add documentation for led matrix 6 vuotta sitten
feature_macros.md 9d97e47df4 [Docs] Update Super ALT↯TAB to remove use of unregister_code16 (#5766) 6 vuotta sitten
feature_mouse_keys.md 4856552f8b Update mouse keys docs (#5653) 6 vuotta sitten
feature_oled_driver.md 6e6d079dd2 Updated OLED Docs with notes about screen timeout. (#6276) 6 vuotta sitten
feature_pointing_device.md af37bb2f78 Fix some of the more obvious typos 8 vuotta sitten
feature_ps2_mouse.md 58b9b22670 Circuitry sample for PS/2 Mouse (#3959) 7 vuotta sitten
feature_rgb_matrix.md bba5c09b23 [Docs] Update feature_rgb_matrix.md (#6117) 6 vuotta sitten
feature_rgblight.md 670a9b7f83 Add effect range to rgblight.c (#5856) 6 vuotta sitten
feature_space_cadet.md d16db69367 Added mod carry over from press to release. (#5866) 6 vuotta sitten
feature_stenography.md c0baf2a964 Improve state/chord handling and clean up namespace 7 vuotta sitten
feature_swap_hands.md fd085837e1 fix swap_hands keycodes in documentation (#3588) 7 vuotta sitten
feature_tap_dance.md 6d4f6f3f49 [Docs] Add Tap Dance example to the docs (#5326) 6 vuotta sitten
feature_terminal.md 5112af887a Added command history to terminal with other bug fixes, added new song to song_list.h (#2855) 7 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) 6 vuotta sitten
feature_userspace.md b541369c45 [Docs] Fix typo in Userspace doc (#5871) 6 vuotta sitten
feature_velocikey.md c1c5922aae Velocikey: Match RGB animation speed to typing speed (#3754) 6 vuotta sitten
features.md 36f427f40c Fix typo 6 vuotta sitten
flashing.md ab29481391 Fix link to Caterina bootloader hex files (#5452) 6 vuotta sitten
fuse.txt ca01d94005 convert docs to lowercase and underscores 8 vuotta sitten
getting_started_build_tools.md 4f2f2271cd Change from avr-gcc@7 to @8 for Mac 6 vuotta sitten
getting_started_getting_help.md 48913153c3 Replace gitter links with Discord. (#3368) 7 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) 6 vuotta sitten
getting_started_make_guide.md c7c4937eef Clean up debounce a bit (#5255) 6 vuotta sitten
getting_started_vagrant.md af37bb2f78 Fix some of the more obvious typos 8 vuotta sitten
hand_wire.md 53c51f1d16 A better new_project.sh (#5191) 6 vuotta sitten
hardware.md af37bb2f78 Fix some of the more obvious typos 8 vuotta sitten
hardware_avr.md 53c51f1d16 A better new_project.sh (#5191) 6 vuotta sitten
hardware_drivers.md 0a645225b9 OLED Driver Feature 6 vuotta sitten
hardware_keyboard_guidelines.md aeee735f35 Clarify LAYOUT vs LAYOUT_all 6 vuotta sitten
how_keyboards_work.md e0a0d80bd3 docs to Mandarin Chinese (#5960) 6 vuotta sitten
i2c_driver.md 155be34a1d Parameterise STM32 I2C pin modes and timing parameters. (#5671) 6 vuotta sitten
index.html fe6b8edd58 use twitter card large setting for larger previews 6 vuotta sitten
internals_defines.md ae7284edb8 rename api docs to internals 7 vuotta sitten
internals_gpio_control.md 3c26f07f5a Grammatical fixes for GPIO Control doc (#4869) 6 vuotta sitten
internals_input_callback_reg.md ae7284edb8 rename api docs to internals 7 vuotta sitten
internals_midi_device.md ae7284edb8 rename api docs to internals 7 vuotta sitten
internals_midi_device_setup_process.md ae7284edb8 rename api docs to internals 7 vuotta sitten
internals_midi_util.md ae7284edb8 rename api docs to internals 7 vuotta sitten
internals_send_functions.md ae7284edb8 rename api docs to internals 7 vuotta sitten
internals_sysex_tools.md ae7284edb8 rename api docs to internals 7 vuotta sitten
isp_flashing_guide.md 1dda671e4a ISP Flashing Guide - atmega32a info (#4993) 6 vuotta sitten
keycodes.md 1a442f9989 [Docs] Reword confusing description of `TO(layer)` (#6174) 6 vuotta sitten
keycodes_basic.md ba05f9667b Add new brightness aliases to keycodes_basic.md 6 vuotta sitten
keycodes_us_ansi_shifted.md 9374c0c9db Add caveats for shifted characters (#4192) 7 vuotta sitten
keymap.md c534a4c775 [Docs] Smallish overhaul of the docs (#5281) 6 vuotta sitten
newbs.md efe360464d Contribute the MechMerlin QMK Configurator docs (#4986) 6 vuotta sitten
newbs_best_practices.md 480651cf9d Docs: Adding QMK Git Conventions doc; formatting cleanup on Learning Resources doc (#3902) 7 vuotta sitten
newbs_building_firmware.md a5b10e5da2 Fix syntax for windows 7 vuotta sitten
newbs_building_firmware_configurator.md efe360464d Contribute the MechMerlin QMK Configurator docs (#4986) 6 vuotta sitten
newbs_flashing.md 663ca6ba9d Documentation: Newbs Flashing: Hightlight that sudo may be needed (#6300) 6 vuotta sitten
newbs_getting_started.md 161d469f2c [Docs] Recursively clone qmk_firmware repo (#5378) 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 da995d2aea [Docs] Add examples to debugging docs (#5555) 6 vuotta sitten
other_eclipse.md e9ace14878 [Docs] Add VSCode guide to docs (#5124) 6 vuotta sitten
other_vscode.md e9ace14878 [Docs] Add VSCode guide to docs (#5124) 6 vuotta sitten
porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md 53c51f1d16 A better new_project.sh (#5191) 6 vuotta sitten
power.txt bb53635f33 Trim trailing whitespace 8 vuotta sitten
proton_c_conversion.md 3cf179be61 Adds Proton C Conversion (#4661) 6 vuotta sitten
python_development.md a25dd58bc5 QMK CLI and JSON keymap support (#6176) 6 vuotta sitten
qmk.css ccc87421e7 Some more tweaks to make everything look nice 7 vuotta sitten
quantum_keycodes.md c6184d2e7e Added check for event pressed to clear space cadet (#5839) 6 vuotta sitten
redirects.json 03ad6927cb Docs: Format Space Cadet documentation (#3540) 7 vuotta sitten
ref_functions.md 75a51659ab Add tap_random_base64 and software timer info to Useful Functions doc (#4360) 7 vuotta sitten
reference_configurator_support.md 9cc5841a91 Update reference_configurator_support.md 6 vuotta sitten
reference_glossary.md dad79cafcd Fix more broken links to the HID spec 7 vuotta sitten
reference_info_json.md bcb1815420 Add label to the info.json reference 6 vuotta sitten
sidebar.css 7d49a17781 override hamburger placement 7 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. 7 vuotta sitten
understanding_qmk.md c534a4c775 [Docs] Smallish overhaul of the docs (#5281) 6 vuotta sitten
unit_testing.md bb53635f33 Trim trailing whitespace 8 vuotta sitten
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores 8 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 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.