Startseite Erkunden Hilfe
Registrieren Anmelden
HuiJun
/
qmk_firmware
1
0
Fork 0
Dateien Issues 0 Pull-Requests 0 Wiki
Struktur: a8466df62d
Branches Tags
qmk_firmware
/
docs
drashna 3c15c48e6a Add "KC_MAKE" to userspace example vor 7 Jahren
..
gitbook 4580d3a730 RGB improvements (#1684) vor 7 Jahren
README.md 800ec55dfc Make arguments redo, subproject elimination (#1784) vor 7 Jahren
_summary.md 66f13e4972 Move keycodes to their own section vor 7 Jahren
becoming_a_qmk_collaborator.md ca01d94005 convert docs to lowercase and underscores vor 8 Jahren
compatible_microcontrollers.md ca01d94005 convert docs to lowercase and underscores vor 8 Jahren
config_options.md 04b9b62bdc RETRO_TAPPING (#1922) vor 7 Jahren
contributing.md 00733f4b87 update contributing guidelines vor 7 Jahren
custom_quantum_functions.md a543ad4c1d Fix minor formatting issue. vor 8 Jahren
documentation_best_practices.md 9d1a08e38a Doc updates from going through every file vor 7 Jahren
documentation_templates.md 800ec55dfc Make arguments redo, subproject elimination (#1784) vor 7 Jahren
eclipse.md d8e29b53fe Update a bunch of docs vor 8 Jahren
faq.md e6c638bed1 Overhaul the Getting Started section and add a FAQ section vor 7 Jahren
faq_build.md 78923cb884 Fix code backticks on Frequently Asked Build Questions docs vor 7 Jahren
faq_debug.md 392121b10e Document the Teensy hardware reset problem vor 7 Jahren
faq_general.md 32bb8f6b8a Improvements to documentation (#1919) vor 7 Jahren
faq_keymap.md 67cc5cebc0 Restructure the hardware and feature docs to make things easier to find (#1888) vor 7 Jahren
feature_advanced_keycodes.md 89357b96d4 333fred layout update (#1971) vor 7 Jahren
feature_audio.md 9d1a08e38a Doc updates from going through every file vor 7 Jahren
feature_auto_shift.md 245b3376d6 Correct the rules.mk documentation for auto shift. vor 7 Jahren
feature_backlight.md 9b879b1267 break up keymaps and quantum keycodes into files by feature vor 7 Jahren
feature_bluetooth.md 9d1a08e38a Doc updates from going through every file vor 7 Jahren
feature_bootmagic.md 29bcffb3f3 Edited a minor typo in feature_bootmagic.md. vor 7 Jahren
feature_dynamic_macros.md 67cc5cebc0 Restructure the hardware and feature docs to make things easier to find (#1888) vor 7 Jahren
feature_key_lock.md 67cc5cebc0 Restructure the hardware and feature docs to make things easier to find (#1888) vor 7 Jahren
feature_layouts.md 800ec55dfc Make arguments redo, subproject elimination (#1784) vor 7 Jahren
feature_leader_key.md 9d1a08e38a Doc updates from going through every file vor 7 Jahren
feature_macros.md 67cc5cebc0 Restructure the hardware and feature docs to make things easier to find (#1888) vor 7 Jahren
feature_mouse_keys.md 67cc5cebc0 Restructure the hardware and feature docs to make things easier to find (#1888) vor 7 Jahren
feature_pointing_device.md ee13228486 Generic Pointing Device (#1767) vor 7 Jahren
feature_ps2_mouse.md 966e2660cf Add option to reverse PS2 mouse axes and scrolling vor 7 Jahren
feature_rgblight.md 1f43495922 Added a new keycode for cycling through RBG modes which reverses directions when shift is hold. vor 7 Jahren
feature_space_cadet.md 67cc5cebc0 Restructure the hardware and feature docs to make things easier to find (#1888) vor 7 Jahren
feature_stenography.md bf1fedc05e Fixed various feature links vor 7 Jahren
feature_tap_dance.md 4c1164c469 fixed two typos vor 7 Jahren
feature_terminal.md 7ad924bae5 Updates send_string functionality, adds terminal feature (#1657) vor 7 Jahren
feature_thermal_printer.md 9b879b1267 break up keymaps and quantum keycodes into files by feature vor 7 Jahren
feature_unicode.md 67cc5cebc0 Restructure the hardware and feature docs to make things easier to find (#1888) vor 7 Jahren
feature_userspace.md 3c15c48e6a Add "KC_MAKE" to userspace example vor 7 Jahren
features.md 49c32021db Added missing RGB and Auto Shift in main feature list. Also standardized on period at the end of each feature list item. vor 7 Jahren
flashing.md 4d421ee31c adds flashing docs vor 7 Jahren
fuse.txt ca01d94005 convert docs to lowercase and underscores vor 8 Jahren
getting_started_build_tools.md 32bb8f6b8a Improvements to documentation (#1919) vor 7 Jahren
getting_started_github.md d069a42c07 Update getting_started_github.md vor 7 Jahren
getting_started_introduction.md bb11df6b7a update some docs vor 7 Jahren
getting_started_make_guide.md 67cc5cebc0 Restructure the hardware and feature docs to make things easier to find (#1888) vor 7 Jahren
getting_started_vagrant.md bb11df6b7a update some docs vor 7 Jahren
glossary.md 67cc5cebc0 Restructure the hardware and feature docs to make things easier to find (#1888) vor 7 Jahren
hand_wire.md 309a400b3e Update hand_wire.md vor 7 Jahren
hardware.md 67cc5cebc0 Restructure the hardware and feature docs to make things easier to find (#1888) vor 7 Jahren
hardware_avr.md 67cc5cebc0 Restructure the hardware and feature docs to make things easier to find (#1888) vor 7 Jahren
hardware_drivers.md 67cc5cebc0 Restructure the hardware and feature docs to make things easier to find (#1888) vor 7 Jahren
hardware_keyboard_guidelines.md 535c2f60a9 use real greater than and less than chars vor 7 Jahren
how_keyboards_work.md 9fed4f7948 Add link to keycodes doc in how_keyboards_work vor 7 Jahren
isp_flashing_guide.md c208a6d4e5 update docs for isp vor 8 Jahren
keycode.txt d9f95c5da9 Docfix (#1377) vor 8 Jahren
keycodes.md 4df4fa7c26 Clarify `KC_PWR` vs `KC_POWER`. Fixes #1994. vor 7 Jahren
keycodes_basic.md c8d365f5da platform descriptions to match master keycodes.md documentation vor 7 Jahren
keycodes_us_ansi_shifted.md 9b879b1267 break up keymaps and quantum keycodes into files by feature vor 7 Jahren
keymap.md e236f1eba1 Fixed some grammar and typos on the docs (#1989) vor 7 Jahren
porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md 995c3141a6 convert docs to lowercase and underscores vor 8 Jahren
power.txt 995c3141a6 convert docs to lowercase and underscores vor 8 Jahren
quantum_keycodes.md 67cc5cebc0 Restructure the hardware and feature docs to make things easier to find (#1888) vor 7 Jahren
redirects.json 67cc5cebc0 Restructure the hardware and feature docs to make things easier to find (#1888) vor 7 Jahren
understanding_qmk.md abba393f57 Added Auto Shift, tap key = normal, hold key = shifted state. vor 7 Jahren
unit_testing.md 800ec55dfc Make arguments redo, subproject elimination (#1784) vor 7 Jahren
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores vor 8 Jahren

README.md

Quantum Mechanical Keyboard Firmware

What is QMK Firmware? {#what-is-qmk-firmware}

QMK (Quantum Mechanical Keyboard) is an open source community that maintains QMK Firmware, QMK Flasher, 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 {#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 {#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 {#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.