ホーム エクスプローラ ヘルプ
サインイン
Tankernn
/
qmk_firmware
1
0
フォーク 0
ファイル 課題 0 プルリクエスト 0 Wiki
ツリー: c6184d2e7e
ブランチ タグ
qmk_firmware
/
docs
XScorpion2 c6184d2e7e Added check for event pressed to clear space cadet (#5839) 6 年 前
..
gitbook 4580d3a730 RGB improvements (#1684) 8 年 前
zh 3cf179be61 Adds Proton C Conversion (#4661) 6 年 前
zh-cn 7871a465d3 translate docs into Mandarin Chinese (#5807) 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 d67b99ff3c Added OLED Driver to the summary 6 年 前
arm_debugging.md ac7b2d92bf ARM SWD guide 7 年 前
becoming_a_qmk_collaborator.md 1acaf2b2c2 Tweak the wording in "Becoming a QMK Collaborator" 7 年 前
compatible_microcontrollers.md 7b0356d1d4 Convert all headings to Title Case 8 年 前
config_options.md 7e655a207e Add option to enable LTO easily (#5674) 6 年 前
contributing.md 068571b9fe Update our style guide (#5500) 6 年 前
custom_quantum_functions.md 5701b75e3c Custom Tapping Term per key (#5009) 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 年 前
faq.md e6c638bed1 Overhaul the Getting Started section and add a FAQ section 8 年 前
faq_build.md 2519de92b5 [Docs] Add udev rule for Input Club bootloaders (#5494) 6 年 前
faq_debug.md bb53635f33 Trim trailing whitespace 8 年 前
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 6d4f6f3f49 [Docs] Add Tap Dance example to the docs (#5326) 6 年 前
feature_audio.md 4f0dc945c3 [Docs] Add music_map to audio documentation (#5419) 6 年 前
feature_auto_shift.md 303f425c6b Fix up info boxes. 7 年 前
feature_backlight.md b61baf4281 Fix #3566 use an hardware timer for software PWM stability (#3615) 6 年 前
feature_bluetooth.md 914d42acd0 Update Bluetooth docs (#4062) 7 年 前
feature_bootmagic.md 3a513fc3a3 [Docs] Bootmagic Lite Caveat (#5069) 6 年 前
feature_combo.md 606b1fe82f Remove caveat about combos with shared keys (#5601) 6 年 前
feature_command.md 5cb713148d Change Command keycode defaults to match corresponding Bootmagic codes (#5078) 6 年 前
feature_debounce_type.md 17e7762de7 Eager Per Row Debouncing added (added to Ergodox) (#5498) 6 年 前
feature_dynamic_macros.md 6caea0acfb Docs: Adjust dynamic macro docs to include more than the planck (#3509) 7 年 前
feature_encoders.md 1e1b55fbdf Improve Encoder documentation (#5130) 6 年 前
feature_grave_esc.md 3510d8dc8d Document an annoyance with Grave Escape and macOS Terminal (#5483) 6 年 前
feature_haptic_feedback.md 2cee371bf1 Haptic feedback generalized - DRV2605 and solenoids (#4939) 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 33e27b2a83 Fixing readme from feedback 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 fd23a0e909 RGB Matrix Effects: Cycle Out to In & Cycle Out to In Dual (#5812) 6 年 前
feature_rgblight.md febaf9dec4 [Docs] RGB Animation documentation on reducing memory footprint (#5813) 6 年 前
feature_space_cadet.md c6184d2e7e Added check for event pressed to clear space cadet (#5839) 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 6d4f6f3f49 [Docs] Add Tap Dance example to the docs (#5326) 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 bdc8d89e6b New keycode macro (XP) for shifted character pairs using UNICODEMAP + bug fixes and improvements (#4803) 6 年 前
feature_userspace.md 3d446c6050 [Docs] Update the KC_MAKE example in Userspace docs (#5337) 6 年 前
feature_velocikey.md c1c5922aae Velocikey: Match RGB animation speed to typing speed (#3754) 6 年 前
features.md 16f367348a [Docs] Fix Space Cadet link (#5825) 6 年 前
flashing.md ab29481391 Fix link to Caterina bootloader hex files (#5452) 6 年 前
fuse.txt ca01d94005 convert docs to lowercase and underscores 8 年 前
getting_started_build_tools.md 4882f7f16d Revert "Update build instructions and docker file to download submodules" (#5533) 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 c5c112ae29 Update config.h boilerplate to use `#pragma once` 7 年 前
getting_started_make_guide.md c7c4937eef Clean up debounce a bit (#5255) 6 年 前
getting_started_vagrant.md af37bb2f78 Fix some of the more obvious typos 8 年 前
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 53c51f1d16 A better new_project.sh (#5191) 6 年 前
hardware_drivers.md 0a645225b9 OLED Driver Feature 6 年 前
hardware_keyboard_guidelines.md aeee735f35 Clarify LAYOUT vs LAYOUT_all 6 年 前
how_keyboards_work.md c02c7b7517 Fix ascii art (#5407) 6 年 前
i2c_driver.md 37932c293c Next set of split_common changes (#4974) 6 年 前
index.html 3cf179be61 Adds Proton C Conversion (#4661) 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 c6184d2e7e Added check for event pressed to clear space cadet (#5839) 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 efe360464d Contribute the MechMerlin QMK Configurator docs (#4986) 6 年 前
newbs_flashing.md c534a4c775 [Docs] Smallish overhaul of the docs (#5281) 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 53c51f1d16 A better new_project.sh (#5191) 6 年 前
power.txt bb53635f33 Trim trailing whitespace 8 年 前
proton_c_conversion.md 3cf179be61 Adds Proton C Conversion (#4661) 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 75a51659ab Add tap_random_base64 and software timer info to Useful Functions doc (#4360) 7 年 前
reference_configurator_support.md d8f090e559 Docs: Supporting a keyboard in the QMK Configurator (#4396) 7 年 前
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.