Startsida Utforska Hjälp
Registrera dig Logga in
HuiJun
/
qmk_firmware
1
0
Fork 0
Filer Ärenden 0 Pull-förfrågningar 0 Wiki
Träd: 5368235f22
Grenar Taggar
qmk_firmware
/
docs
Yan-Fa Li 713ec91147 Add C hint to inline code 6 år sedan
..
gitbook 4580d3a730 RGB improvements (#1684) 7 år sedan
.nojekyll 9e5676650e Use docsfy to replace gitbook 7 år sedan
CNAME 4d26137e2a Create CNAME 7 år sedan
README.md 73ddb764cc Fix readme and contributing hyperlinks 7 år sedan
_sidebar.md eb19fb5b57 Helpful functions 6 år sedan
_summary.md eb19fb5b57 Helpful functions 6 år sedan
becoming_a_qmk_collaborator.md 1acaf2b2c2 Tweak the wording in "Becoming a QMK Collaborator" 6 år sedan
compatible_microcontrollers.md 7b0356d1d4 Convert all headings to Title Case 7 år sedan
config_options.md 743449472e Make `PREVENT_STUCK_MODIFIERS` the default (#3107) 6 år sedan
contributing.md b1f11636c6 docs/contributing: add `#pragma once` to Coding Conventions 6 år sedan
custom_quantum_functions.md 713ec91147 Add C hint to inline code 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) 6 år sedan
eclipse.md 8e99fbc884 Fixed typo of 'confid.h' to 'config.h' (#2448) 7 år sedan
faq.md e6c638bed1 Overhaul the Getting Started section and add a FAQ section 7 år sedan
faq_build.md 0d5a8b048a Instruct macos users to use avr-gcc@7 (#3337) 7 år sedan
faq_debug.md bb53635f33 Trim trailing whitespace 7 år sedan
faq_general.md 7b0356d1d4 Convert all headings to Title Case 7 år sedan
faq_keymap.md bfc9aa66f9 Docs: Update image in FAQ/Keymap: KC_EQLS -> KC_EQL (#3660) 6 år sedan
feature_advanced_keycodes.md ce3ccd3f4a Docs: Tabulate Modifier & Mod-Tap keycode listings in advanced keycodes docs (#3799) 6 år sedan
feature_audio.md a0309db983 Add On/Off keycodes 6 år sedan
feature_auto_shift.md 303f425c6b Fix up info boxes. 7 år sedan
feature_backlight.md eb19fb5b57 Helpful functions 6 år sedan
feature_bluetooth.md 4c675a83ba Format keycode tables 7 år sedan
feature_bootmagic.md a6d1db2c27 Create AG_TOGG code to toggle Alt/Gui swap. 6 år sedan
feature_command.md 25d757284c Docs: Fix Command docs escaping (#3523) 6 år sedan
feature_dynamic_macros.md 6caea0acfb Docs: Adjust dynamic macro docs to include more than the planck (#3509) 6 år sedan
feature_grave_esc.md 2bc34b09cd Docs: Format Grave Escape documentation (#3536) 6 år sedan
feature_hd44780.md bbea9dadbc Integrating Peter Fleury's HD44780 LCD library (#3209) 6 år sedan
feature_key_lock.md c11a26ba54 Docs: Format Key Lock documentation (#3538) 6 år sedan
feature_layouts.md 08c682c193 Docs: Add docs for the `LAYOUT_*` macro to layouts (#3772) 6 år sedan
feature_leader_key.md 244e1c5a57 Fix LEADER_KEY docs. 6 år sedan
feature_macros.md 26f4e7031a Add tap_code function (#3784) 6 år sedan
feature_mouse_keys.md 7f7f763598 Fixed dead links (#2451) 7 år sedan
feature_pointing_device.md af37bb2f78 Fix some of the more obvious typos 7 år sedan
feature_ps2_mouse.md 58b9b22670 Circuitry sample for PS/2 Mouse (#3959) 6 år sedan
feature_rgb_matrix.md da6c58175a Make digital rain RGB matrix effect #define configurable. 6 år sedan
feature_rgblight.md 6d6d91c834 rgblight.[ch] more configurable (#3582) 6 år sedan
feature_space_cadet_shift.md 03ad6927cb Docs: Format Space Cadet documentation (#3540) 6 år sedan
feature_space_cadet_shift_enter.md 03ad6927cb Docs: Format Space Cadet documentation (#3540) 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) 6 år sedan
feature_tap_dance.md bb86d8a00c Docs: Fix some minor errors in tap dance example (#3530) 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 7 år sedan
feature_unicode.md f5ae3760c6 Add send_unicode_hex_string function (#3828) 6 år sedan
feature_userspace.md f1b2d46eaf Spell-check update for Userspace documentation 6 år sedan
features.md d263b27c9a Dedupe shifted keycodes listing 6 år sedan
flashing.md b3f6aa9480 Correct small typo 6 år sedan
fuse.txt ca01d94005 convert docs to lowercase and underscores 8 år sedan
getting_started_build_tools.md 0d5a8b048a Instruct macos users to use avr-gcc@7 (#3337) 7 år sedan
getting_started_getting_help.md 48913153c3 Replace gitter links with Discord. (#3368) 7 år sedan
getting_started_github.md f2fcffab0d Docs: Adjust prompt to be more recognizable (#3417) 6 år sedan
getting_started_introduction.md c5c112ae29 Update config.h boilerplate to use `#pragma once` 6 år sedan
getting_started_make_guide.md 0fab3bbde3 Lets split eh (#3120) 6 år sedan
getting_started_vagrant.md af37bb2f78 Fix some of the more obvious typos 7 år sedan
hand_wire.md bb53635f33 Trim trailing whitespace 7 år sedan
hardware.md af37bb2f78 Fix some of the more obvious typos 7 år sedan
hardware_avr.md 303f425c6b Fix up info boxes. 7 år sedan
hardware_drivers.md fdd0f91527 ISSI31FL3733 driver (#3679) 6 år sedan
hardware_keyboard_guidelines.md 9fb1e5d171 Remove bootloader key as it is no longer used (#3093) 7 år sedan
how_keyboards_work.md 7b0356d1d4 Convert all headings to Title Case 7 år sedan
index.html 7d49a17781 override hamburger placement 7 år sedan
internals_defines.md ae7284edb8 rename api docs to internals 7 år sedan
internals_gpio_control.md 7fe03d085c Update quantum matrix to support both AVR and Chibios ARM (#3968) 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 ac46378ac6 Update ISP flashing guide with pre-compiled binary (#3217) 6 år sedan
keycode.txt bb53635f33 Trim trailing whitespace 7 år sedan
keycodes.md a6d1db2c27 Create AG_TOGG code to toggle Alt/Gui swap. 6 år sedan
keycodes_basic.md 435a1202e7 More improvements to keycode docs (#3567) 6 år sedan
keycodes_us_ansi_shifted.md f6ec2ce201 Update Shifted keycodes docs (#3575) 6 år sedan
keymap.md 334e2629df Remove redefinition of `_______` in documentation example (#3924) 6 år sedan
newbs.md c7b8e45ba1 Docs: add resources for git (#3390) 7 år sedan
newbs_building_firmware.md 170de1273c Add an easy way to create new keymaps for your favorite keyboard (#3868) 6 år sedan
newbs_flashing.md 303f425c6b Fix up info boxes. 7 år sedan
newbs_getting_started.md 06b3637266 added some helpful notes to the documentation (#2981) 7 år sedan
newbs_learn_more_resources.md c7b8e45ba1 Docs: add resources for git (#3390) 7 år sedan
newbs_testing_debugging.md 08e48eb6f5 Add a newbie guide for people completely new to QMK (#2480) 7 år sedan
porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md af37bb2f78 Fix some of the more obvious typos 7 år sedan
power.txt bb53635f33 Trim trailing whitespace 7 år sedan
qmk.css ccc87421e7 Some more tweaks to make everything look nice 7 år sedan
quantum_keycodes.md bb53635f33 Trim trailing whitespace 7 år sedan
redirects.json 03ad6927cb Docs: Format Space Cadet documentation (#3540) 6 år sedan
ref_functions.md eb19fb5b57 Helpful functions 6 år sedan
reference_glossary.md 03ad6927cb Docs: Format Space Cadet documentation (#3540) 6 år sedan
sidebar.css 7d49a17781 override hamburger placement 7 år sedan
sw.js 303f425c6b Fix up info boxes. 7 år sedan
understanding_qmk.md 743449472e Make `PREVENT_STUCK_MODIFIERS` the default (#3107) 6 år sedan
unit_testing.md bb53635f33 Trim trailing whitespace 7 å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.