Startsida Utforska Hjälp
Logga in
Tankernn
/
qmk_firmware
1
0
Fork 0
Filer Ärenden 0 Pull-förfrågningar 0 Wiki
Träd: 129e4d1b2f
Grenar Taggar
qmk_firmware
/
docs
madivad 129e4d1b2f [Docs] Update how_keyboards_work.md (#6528) 6 år sedan
..
gitbook 4580d3a730 RGB improvements (#1684) 8 år sedan
zh 3cf179be61 Adds Proton C Conversion (#4661) 6 år sedan
zh-cn f2c179de58 Remove superfluous JTAG disable code (#6445) 6 år sedan
.nojekyll 9e5676650e Use docsfy to replace gitbook 7 år sedan
CNAME 4d26137e2a Create CNAME 7 år sedan
LANGS.md d5a06aec83 Second try at configuring i18n for docsify and gitbook (#4531) 7 år sedan
README.md 73ddb764cc Fix readme and contributing hyperlinks 7 år sedan
_summary.md 311d625c56 [Docs] Add dedicated page for Split Keyboard information (#5802) 6 år sedan
arm_debugging.md ac7b2d92bf ARM SWD guide 7 år sedan
becoming_a_qmk_collaborator.md 1acaf2b2c2 Tweak the wording in "Becoming a QMK Collaborator" 7 år sedan
cli.md a25dd58bc5 QMK CLI and JSON keymap support (#6176) 6 år sedan
coding_conventions_c.md a25dd58bc5 QMK CLI and JSON keymap support (#6176) 6 år sedan
coding_conventions_python.md a25dd58bc5 QMK CLI and JSON keymap support (#6176) 6 år sedan
compatible_microcontrollers.md 7b0356d1d4 Convert all headings to Title Case 8 år sedan
config_options.md 4d72aa428f Improve backlight PWM pin support (#6202) 6 år sedan
contributing.md a25dd58bc5 QMK CLI and JSON keymap support (#6176) 6 år sedan
custom_quantum_functions.md b62e160a89 Additional changes for Layer State typedef compatibility (#5906) 6 år sedan
documentation_best_practices.md 303f425c6b Fix up info boxes. 7 år sedan
documentation_templates.md 8454fa5e9f Update Document Templates to reflect newer wording and URLs (#4006) 7 år sedan
faq.md e6c638bed1 Overhaul the Getting Started section and add a FAQ section 8 år sedan
faq_build.md b567785345 [Docs] Add dfu-util and caterina udev examples (#6429) 6 år sedan
faq_debug.md f2c179de58 Remove superfluous JTAG disable code (#6445) 6 år sedan
faq_general.md 7b0356d1d4 Convert all headings to Title Case 8 år sedan
faq_keymap.md 384fef72d3 Replace instances of KEYMAP with LAYOUT 6 år sedan
feature_advanced_keycodes.md c1c0cf73ce fix typo 6 år sedan
feature_audio.md d534c72a54 Added keycodes for swapping and unswapping the Control and OS keys (#6110) 6 år sedan
feature_auto_shift.md 303f425c6b Fix up info boxes. 7 år sedan
feature_backlight.md 4d72aa428f Improve backlight PWM pin support (#6202) 6 år sedan
feature_bluetooth.md 914d42acd0 Update Bluetooth docs (#4062) 7 år sedan
feature_bootmagic.md d534c72a54 Added keycodes for swapping and unswapping the Control and OS keys (#6110) 6 år sedan
feature_combo.md 57540af102 Change "yu" to "you" in combo docs (#6510) 6 år sedan
feature_command.md a2e91ebec9 Update IS_COMMAND definitions to use MOD_MASK_SHIFT (#6348) 6 år sedan
feature_debounce_type.md 17e7762de7 Eager Per Row Debouncing added (added to Ergodox) (#5498) 6 år sedan
feature_dynamic_macros.md 6caea0acfb Docs: Adjust dynamic macro docs to include more than the planck (#3509) 7 år sedan
feature_encoders.md 36dd261d06 Add support for different encoder pinout for right half of split keyboard (#6521) 6 år sedan
feature_grave_esc.md 3510d8dc8d Document an annoyance with Grave Escape and macOS Terminal (#5483) 6 år sedan
feature_haptic_feedback.md 2cee371bf1 Haptic feedback generalized - DRV2605 and solenoids (#4939) 6 år sedan
feature_hd44780.md bbea9dadbc Integrating Peter Fleury's HD44780 LCD library (#3209) 7 år sedan
feature_key_lock.md c11a26ba54 Docs: Format Key Lock documentation (#3538) 7 år sedan
feature_layouts.md 40e67a3074 Add a mechanism for force building a particular community layout (#5027) 6 år sedan
feature_leader_key.md afd5cda4a0 Fix up process_leader to be a bit more optimized (#4662) 7 år sedan
feature_led_matrix.md 24df54b807 Add documentation for led matrix 6 år sedan
feature_macros.md 9d97e47df4 [Docs] Update Super ALT↯TAB to remove use of unregister_code16 (#5766) 6 år sedan
feature_mouse_keys.md 4856552f8b Update mouse keys docs (#5653) 6 år sedan
feature_oled_driver.md b62e160a89 Additional changes for Layer State typedef compatibility (#5906) 6 år sedan
feature_pointing_device.md af37bb2f78 Fix some of the more obvious typos 8 år sedan
feature_ps2_mouse.md 58b9b22670 Circuitry sample for PS/2 Mouse (#3959) 7 år sedan
feature_rgb_matrix.md 91ee6a1dbb [Docs] Add RGB Matrix default mode define info (#6564) 6 år sedan
feature_rgblight.md 670a9b7f83 Add effect range to rgblight.c (#5856) 6 år sedan
feature_space_cadet.md d16db69367 Added mod carry over from press to release. (#5866) 6 år sedan
feature_split_keyboard.md 36dd261d06 Add support for different encoder pinout for right half of split keyboard (#6521) 6 år sedan
feature_stenography.md c0baf2a964 Improve state/chord handling and clean up namespace 7 år sedan
feature_swap_hands.md fd085837e1 fix swap_hands keycodes in documentation (#3588) 7 år sedan
feature_tap_dance.md a747953dfa [Docs] Add Sections and MO(layer)/TG(layer) Example (#6308) 6 år sedan
feature_terminal.md 5112af887a Added command history to terminal with other bug fixes, added new song to song_list.h (#2855) 7 år sedan
feature_thermal_printer.md 4c675a83ba Format keycode tables 8 år sedan
feature_unicode.md ecf0612cc8 [Docs] Clarify the rules.mk setup for Unicode (#6286) 6 år sedan
feature_userspace.md b62e160a89 Additional changes for Layer State typedef compatibility (#5906) 6 år sedan
feature_velocikey.md c1c5922aae Velocikey: Match RGB animation speed to typing speed (#3754) 6 år sedan
features.md 311d625c56 [Docs] Add dedicated page for Split Keyboard information (#5802) 6 år sedan
flashing.md 3538955778 Usbasploader bootloader option addition (#6304) 6 år sedan
fuse.txt ca01d94005 convert docs to lowercase and underscores 8 år sedan
getting_started_build_tools.md 4f2f2271cd Change from avr-gcc@7 to @8 for Mac 6 år sedan
getting_started_getting_help.md 48913153c3 Replace gitter links with Discord. (#3368) 7 år sedan
getting_started_github.md 76aa2baf3e Fix doc typo 7 år sedan
getting_started_introduction.md d3317a8a66 [Docs] Update getting_started_introduction.md (#6037) 6 år sedan
getting_started_make_guide.md 4d72aa428f Improve backlight PWM pin support (#6202) 6 år sedan
getting_started_vagrant.md 29e9caa82b Configure Vagrant to use qmk_base_container (#6194) 6 år sedan
hand_wire.md 53c51f1d16 A better new_project.sh (#5191) 6 år sedan
hardware.md af37bb2f78 Fix some of the more obvious typos 8 år sedan
hardware_avr.md ddaf37ffa9 Reword a note about the MANUFACTURER and PRODUCT defines in hardware_avr.md (#6558) 6 år sedan
hardware_drivers.md 0a645225b9 OLED Driver Feature 6 år sedan
hardware_keyboard_guidelines.md aeee735f35 Clarify LAYOUT vs LAYOUT_all 6 år sedan
how_keyboards_work.md 129e4d1b2f [Docs] Update how_keyboards_work.md (#6528) 6 år sedan
i2c_driver.md 4e375aa1f5 Add ARM I2Cv1 support to i2c_master (#6262) 6 år sedan
index.html fe6b8edd58 use twitter card large setting for larger previews 6 år sedan
internals_defines.md ae7284edb8 rename api docs to internals 7 år sedan
internals_gpio_control.md 3c26f07f5a Grammatical fixes for GPIO Control doc (#4869) 6 år sedan
internals_input_callback_reg.md ae7284edb8 rename api docs to internals 7 år sedan
internals_midi_device.md ae7284edb8 rename api docs to internals 7 år sedan
internals_midi_device_setup_process.md ae7284edb8 rename api docs to internals 7 år sedan
internals_midi_util.md ae7284edb8 rename api docs to internals 7 år sedan
internals_send_functions.md ae7284edb8 rename api docs to internals 7 år sedan
internals_sysex_tools.md ae7284edb8 rename api docs to internals 7 år sedan
isp_flashing_guide.md 1dda671e4a ISP Flashing Guide - atmega32a info (#4993) 6 år sedan
keycodes.md d534c72a54 Added keycodes for swapping and unswapping the Control and OS keys (#6110) 6 år sedan
keycodes_basic.md ba05f9667b Add new brightness aliases to keycodes_basic.md 6 år sedan
keycodes_us_ansi_shifted.md 9374c0c9db Add caveats for shifted characters (#4192) 7 år sedan
keymap.md c534a4c775 [Docs] Smallish overhaul of the docs (#5281) 6 år sedan
newbs.md efe360464d Contribute the MechMerlin QMK Configurator docs (#4986) 6 år sedan
newbs_best_practices.md 480651cf9d Docs: Adding QMK Git Conventions doc; formatting cleanup on Learning Resources doc (#3902) 7 år sedan
newbs_building_firmware.md a5b10e5da2 Fix syntax for windows 7 år sedan
newbs_building_firmware_configurator.md c806103f41 Update YouTube URL 6 år sedan
newbs_flashing.md 2f3807682d Fix typo for building Ergodox EZ keyboards (#6453) 6 år sedan
newbs_getting_started.md 161d469f2c [Docs] Recursively clone qmk_firmware repo (#5378) 6 år sedan
newbs_learn_more_resources.md 480651cf9d Docs: Adding QMK Git Conventions doc; formatting cleanup on Learning Resources doc (#3902) 7 år sedan
newbs_testing_debugging.md da995d2aea [Docs] Add examples to debugging docs (#5555) 6 år sedan
other_eclipse.md e9ace14878 [Docs] Add VSCode guide to docs (#5124) 6 år sedan
other_vscode.md e9ace14878 [Docs] Add VSCode guide to docs (#5124) 6 år sedan
porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md 4d72aa428f Improve backlight PWM pin support (#6202) 6 år sedan
power.txt bb53635f33 Trim trailing whitespace 8 år sedan
proton_c_conversion.md 3cf179be61 Adds Proton C Conversion (#4661) 6 år sedan
python_development.md a25dd58bc5 QMK CLI and JSON keymap support (#6176) 6 år sedan
qmk.css ccc87421e7 Some more tweaks to make everything look nice 7 år sedan
quantum_keycodes.md c6184d2e7e Added check for event pressed to clear space cadet (#5839) 6 år sedan
redirects.json 03ad6927cb Docs: Format Space Cadet documentation (#3540) 7 år sedan
ref_functions.md b62e160a89 Additional changes for Layer State typedef compatibility (#5906) 6 år sedan
reference_configurator_support.md 9cc5841a91 Update reference_configurator_support.md 6 år sedan
reference_glossary.md dad79cafcd Fix more broken links to the HID spec 7 år sedan
reference_info_json.md bcb1815420 Add label to the info.json reference 6 år sedan
sidebar.css 7d49a17781 override hamburger placement 7 år sedan
support.md 2ad2b73d68 Add support for PR and Issue templates to QMK_firmware GitHub (#4494) 7 år sedan
sw.js 303f425c6b Fix up info boxes. 7 år sedan
understanding_qmk.md c534a4c775 [Docs] Smallish overhaul of the docs (#5281) 6 år sedan
unit_testing.md bb53635f33 Trim trailing whitespace 8 år sedan
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores 8 år sedan

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.