Эхлэл Бүгдийг харах Тусламж
Нэвтрэх
Tankernn
/
qmk_firmware
1
0
Салаа 0
Файлууд Асуудлууд 0 Хуулах хүсэлтүүд 0 Мэдлэгийн сан
Мод: 42bf60751e
Салаанууд Тагууд
qmk_firmware
/
docs
Drashna Jaelre f069e9fc09 Generalize Tap Dance Layer functions (#6629) 6 жил өмнө
..
ChangeLog d217307747 consistency 6 жил өмнө
gitbook 4580d3a730 RGB improvements (#1684) 8 жил өмнө
zh 3cf179be61 Adds Proton C Conversion (#4661) 6 жил өмнө
zh-cn dab4967f1b Add Dip Switch as a core feature (#6140) 6 жил өмнө
.nojekyll 9e5676650e Use docsfy to replace gitbook 7 жил өмнө
CNAME 4d26137e2a Create CNAME 7 жил өмнө
LANGS.md d5a06aec83 Second try at configuring i18n for docsify and gitbook (#4531) 7 жил өмнө
README.md 73ddb764cc Fix readme and contributing hyperlinks 7 жил өмнө
_summary.md dab4967f1b Add Dip Switch as a core feature (#6140) 6 жил өмнө
arm_debugging.md ac7b2d92bf ARM SWD guide 7 жил өмнө
becoming_a_qmk_collaborator.md 1acaf2b2c2 Tweak the wording in "Becoming a QMK Collaborator" 7 жил өмнө
breaking_changes.md ddb69d4d39 Merge point for 2019 Aug 30 Breaking Change 6 жил өмнө
cli.md 9547774962 CLI command to format C code 6 жил өмнө
coding_conventions_c.md a25dd58bc5 QMK CLI and JSON keymap support (#6176) 6 жил өмнө
coding_conventions_python.md a25dd58bc5 QMK CLI and JSON keymap support (#6176) 6 жил өмнө
compatible_microcontrollers.md 7b0356d1d4 Convert all headings to Title Case 8 жил өмнө
config_options.md 7ffed07310 Make USB polling rate configurable with a define (#6668) 6 жил өмнө
contributing.md a25dd58bc5 QMK CLI and JSON keymap support (#6176) 6 жил өмнө
custom_quantum_functions.md b62e160a89 Additional changes for Layer State typedef compatibility (#5906) 6 жил өмнө
documentation_best_practices.md 303f425c6b Fix up info boxes. 7 жил өмнө
documentation_templates.md 8454fa5e9f Update Document Templates to reflect newer wording and URLs (#4006) 7 жил өмнө
driver_installation_zadig.md c7d0262be7 [Keyboard] Add Discipad, Update Zadig doc for USBaspLoader (#6771) 6 жил өмнө
faq.md e6c638bed1 Overhaul the Getting Started section and add a FAQ section 8 жил өмнө
faq_build.md fb7c65dc34 Add Zadig 101 to docs (#6585) 6 жил өмнө
faq_debug.md f2c179de58 Remove superfluous JTAG disable code (#6445) 6 жил өмнө
faq_general.md 7b0356d1d4 Convert all headings to Title Case 8 жил өмнө
faq_keymap.md 384fef72d3 Replace instances of KEYMAP with LAYOUT 6 жил өмнө
feature_advanced_keycodes.md c1c0cf73ce fix typo 6 жил өмнө
feature_audio.md d534c72a54 Added keycodes for swapping and unswapping the Control and OS keys (#6110) 6 жил өмнө
feature_auto_shift.md 303f425c6b Fix up info boxes. 7 жил өмнө
feature_backlight.md 3642a82d37 Add support for 328P hardware backlight on B1/B2 (#6776) 6 жил өмнө
feature_bluetooth.md 914d42acd0 Update Bluetooth docs (#4062) 7 жил өмнө
feature_bootmagic.md d534c72a54 Added keycodes for swapping and unswapping the Control and OS keys (#6110) 6 жил өмнө
feature_combo.md 57540af102 Change "yu" to "you" in combo docs (#6510) 6 жил өмнө
feature_command.md a2e91ebec9 Update IS_COMMAND definitions to use MOD_MASK_SHIFT (#6348) 6 жил өмнө
feature_debounce_type.md 17e7762de7 Eager Per Row Debouncing added (added to Ergodox) (#5498) 6 жил өмнө
feature_dip_switch.md dab4967f1b Add Dip Switch as a core feature (#6140) 6 жил өмнө
feature_dynamic_macros.md 6caea0acfb Docs: Adjust dynamic macro docs to include more than the planck (#3509) 7 жил өмнө
feature_encoders.md 36dd261d06 Add support for different encoder pinout for right half of split keyboard (#6521) 6 жил өмнө
feature_grave_esc.md 3510d8dc8d Document an annoyance with Grave Escape and macOS Terminal (#5483) 6 жил өмнө
feature_haptic_feedback.md 911b8915cc DRV2605L Continuous Haptic Feedback Support (#6461) 6 жил өмнө
feature_hd44780.md bbea9dadbc Integrating Peter Fleury's HD44780 LCD library (#3209) 7 жил өмнө
feature_key_lock.md c11a26ba54 Docs: Format Key Lock documentation (#3538) 7 жил өмнө
feature_layouts.md 40e67a3074 Add a mechanism for force building a particular community layout (#5027) 6 жил өмнө
feature_leader_key.md afd5cda4a0 Fix up process_leader to be a bit more optimized (#4662) 7 жил өмнө
feature_led_matrix.md 24df54b807 Add documentation for led matrix 6 жил өмнө
feature_macros.md 9d97e47df4 [Docs] Update Super ALT↯TAB to remove use of unregister_code16 (#5766) 6 жил өмнө
feature_mouse_keys.md 4856552f8b Update mouse keys docs (#5653) 6 жил өмнө
feature_oled_driver.md 957070a6b5 Added OLED Display autoscroll during periods of OLED data inactivity (#6546) 6 жил өмнө
feature_pointing_device.md af37bb2f78 Fix some of the more obvious typos 8 жил өмнө
feature_ps2_mouse.md 58b9b22670 Circuitry sample for PS/2 Mouse (#3959) 7 жил өмнө
feature_rgb_matrix.md 91ee6a1dbb [Docs] Add RGB Matrix default mode define info (#6564) 6 жил өмнө
feature_rgblight.md 670a9b7f83 Add effect range to rgblight.c (#5856) 6 жил өмнө
feature_space_cadet.md d16db69367 Added mod carry over from press to release. (#5866) 6 жил өмнө
feature_split_keyboard.md 36dd261d06 Add support for different encoder pinout for right half of split keyboard (#6521) 6 жил өмнө
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) 7 жил өмнө
feature_tap_dance.md f069e9fc09 Generalize Tap Dance Layer functions (#6629) 6 жил өмнө
feature_terminal.md 5112af887a Added command history to terminal with other bug fixes, added new song to song_list.h (#2855) 7 жил өмнө
feature_thermal_printer.md 4c675a83ba Format keycode tables 8 жил өмнө
feature_unicode.md ecf0612cc8 [Docs] Clarify the rules.mk setup for Unicode (#6286) 6 жил өмнө
feature_userspace.md b62e160a89 Additional changes for Layer State typedef compatibility (#5906) 6 жил өмнө
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) 6 жил өмнө
flashing.md de4a47f1cc Cleanup rules.mk for 32A and 328P keyboards (#6767) 6 жил өмнө
flashing_bootloadhid.md 51bcadf38c Add 'bootloadHID' flash target (#5587) 6 жил өмнө
fuse.txt ca01d94005 convert docs to lowercase and underscores 8 жил өмнө
getting_started_build_tools.md 4f2f2271cd Change from avr-gcc@7 to @8 for Mac 6 жил өмнө
getting_started_getting_help.md 48913153c3 Replace gitter links with Discord. (#3368) 7 жил өмнө
getting_started_github.md 76aa2baf3e Fix doc typo 7 жил өмнө
getting_started_introduction.md d3317a8a66 [Docs] Update getting_started_introduction.md (#6037) 6 жил өмнө
getting_started_make_guide.md 51bcadf38c Add 'bootloadHID' flash target (#5587) 6 жил өмнө
getting_started_vagrant.md 29e9caa82b Configure Vagrant to use qmk_base_container (#6194) 6 жил өмнө
hand_wire.md 53c51f1d16 A better new_project.sh (#5191) 6 жил өмнө
hardware.md af37bb2f78 Fix some of the more obvious typos 8 жил өмнө
hardware_avr.md ddaf37ffa9 Reword a note about the MANUFACTURER and PRODUCT defines in hardware_avr.md (#6558) 6 жил өмнө
hardware_drivers.md 0a645225b9 OLED Driver Feature 6 жил өмнө
hardware_keyboard_guidelines.md aeee735f35 Clarify LAYOUT vs LAYOUT_all 6 жил өмнө
how_keyboards_work.md 129e4d1b2f [Docs] Update how_keyboards_work.md (#6528) 6 жил өмнө
i2c_driver.md e6a6b1f122 [Docs] Update i2c_driver.md (#6665) 6 жил өмнө
index.html 27b3f3141b Fix typo in Open Graph description for docs (#6641) 6 жил өмнө
internals_defines.md ae7284edb8 rename api docs to internals 7 жил өмнө
internals_gpio_control.md 3c26f07f5a Grammatical fixes for GPIO Control doc (#4869) 6 жил өмнө
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 d534c72a54 Added keycodes for swapping and unswapping the Control and OS keys (#6110) 6 жил өмнө
keycodes_basic.md ba05f9667b Add new brightness aliases to keycodes_basic.md 6 жил өмнө
keycodes_us_ansi_shifted.md 9374c0c9db Add caveats for shifted characters (#4192) 7 жил өмнө
keymap.md c534a4c775 [Docs] Smallish overhaul of the docs (#5281) 6 жил өмнө
newbs.md efe360464d Contribute the MechMerlin QMK Configurator docs (#4986) 6 жил өмнө
newbs_best_practices.md 480651cf9d Docs: Adding QMK Git Conventions doc; formatting cleanup on Learning Resources doc (#3902) 7 жил өмнө
newbs_building_firmware.md a5b10e5da2 Fix syntax for windows 7 жил өмнө
newbs_building_firmware_configurator.md c806103f41 Update YouTube URL 6 жил өмнө
newbs_flashing.md 51bcadf38c Add 'bootloadHID' flash target (#5587) 6 жил өмнө
newbs_getting_started.md 161d469f2c [Docs] Recursively clone qmk_firmware repo (#5378) 6 жил өмнө
newbs_learn_more_resources.md 480651cf9d Docs: Adding QMK Git Conventions doc; formatting cleanup on Learning Resources doc (#3902) 7 жил өмнө
newbs_testing_debugging.md da995d2aea [Docs] Add examples to debugging docs (#5555) 6 жил өмнө
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) 6 жил өмнө
power.txt bb53635f33 Trim trailing whitespace 8 жил өмнө
proton_c_conversion.md 3cf179be61 Adds Proton C Conversion (#4661) 6 жил өмнө
python_development.md a25dd58bc5 QMK CLI and JSON keymap support (#6176) 6 жил өмнө
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 03ad6927cb Docs: Format Space Cadet documentation (#3540) 7 жил өмнө
ref_functions.md b62e160a89 Additional changes for Layer State typedef compatibility (#5906) 6 жил өмнө
reference_configurator_support.md 9cc5841a91 Update reference_configurator_support.md 6 жил өмнө
reference_glossary.md dad79cafcd Fix more broken links to the HID spec 7 жил өмнө
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) 7 жил өмнө
sw.js 303f425c6b Fix up info boxes. 7 жил өмнө
understanding_qmk.md c534a4c775 [Docs] Smallish overhaul of the docs (#5281) 6 жил өмнө
unit_testing.md bb53635f33 Trim trailing whitespace 8 жил өмнө
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores 8 жил өмнө

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.