Startseite Erkunden Hilfe
Anmelden
Tankernn
/
qmk_firmware
1
0
Fork 0
Dateien Issues 0 Pull-Requests 0 Wiki
Struktur: 42e85d2b92
Branches Tags
qmk_firmware
/
docs
U-LANDSRAAD\drashna 42e85d2b92 Add layer_state_set_* to custom function lists vor 7 Jahren
..
gitbook 4580d3a730 RGB improvements (#1684) vor 8 Jahren
README.md 7b0356d1d4 Convert all headings to Title Case vor 8 Jahren
_summary.md 7b80aea8b2 Add back docs for hand-swapping feature. vor 7 Jahren
becoming_a_qmk_collaborator.md 7b0356d1d4 Convert all headings to Title Case vor 8 Jahren
compatible_microcontrollers.md 7b0356d1d4 Convert all headings to Title Case vor 8 Jahren
config_options.md 4764e77121 Clarify that we actually have max 16 total backlight levels vor 8 Jahren
contributing.md bb53635f33 Trim trailing whitespace vor 8 Jahren
custom_quantum_functions.md 42e85d2b92 Add layer_state_set_* to custom function lists vor 7 Jahren
documentation_best_practices.md af37bb2f78 Fix some of the more obvious typos vor 8 Jahren
documentation_templates.md 800ec55dfc Make arguments redo, subproject elimination (#1784) vor 8 Jahren
eclipse.md 8e99fbc884 Fixed typo of 'confid.h' to 'config.h' (#2448) vor 7 Jahren
faq.md e6c638bed1 Overhaul the Getting Started section and add a FAQ section vor 8 Jahren
faq_build.md 8df2ee4ec3 Minor updates to docs (#2406) vor 7 Jahren
faq_debug.md bb53635f33 Trim trailing whitespace vor 8 Jahren
faq_general.md 7b0356d1d4 Convert all headings to Title Case vor 8 Jahren
faq_keymap.md e87c39d302 More thoroughly document Bootmagic and Command (#2455) vor 7 Jahren
feature_advanced_keycodes.md b713feb6f2 Add a little aside explaining that shifted keys with mod-tap doesn't work (#2446) vor 7 Jahren
feature_audio.md 8e99fbc884 Fixed typo of 'confid.h' to 'config.h' (#2448) vor 7 Jahren
feature_auto_shift.md 63df056013 Update feature_auto_shift.md vor 7 Jahren
feature_backlight.md 4764e77121 Clarify that we actually have max 16 total backlight levels vor 8 Jahren
feature_bluetooth.md 4c675a83ba Format keycode tables vor 8 Jahren
feature_bootmagic.md e87c39d302 More thoroughly document Bootmagic and Command (#2455) vor 7 Jahren
feature_command.md e87c39d302 More thoroughly document Bootmagic and Command (#2455) vor 7 Jahren
feature_dynamic_macros.md bb53635f33 Trim trailing whitespace vor 8 Jahren
feature_grave_esc.md 4c675a83ba Format keycode tables vor 8 Jahren
feature_key_lock.md 7b0356d1d4 Convert all headings to Title Case vor 8 Jahren
feature_layouts.md 2018df1a61 Clarify the format for layout names vor 7 Jahren
feature_leader_key.md 7b0356d1d4 Convert all headings to Title Case vor 8 Jahren
feature_macros.md 31cae1f1bd Update feature_macros.md (#2387) vor 7 Jahren
feature_mouse_keys.md 7f7f763598 Fixed dead links (#2451) vor 7 Jahren
feature_pointing_device.md af37bb2f78 Fix some of the more obvious typos vor 8 Jahren
feature_ps2_mouse.md bb53635f33 Trim trailing whitespace vor 8 Jahren
feature_rgblight.md 6c24e28b8d ADD RGBLIGHT_LIMIT_VAL (#2214) vor 8 Jahren
feature_space_cadet.md af37bb2f78 Fix some of the more obvious typos vor 8 Jahren
feature_space_shift_cadet.md 8a1e656099 new planck keymap, new feature - hybrid shift/enter action key (great for small keyboards!) (#2100) vor 8 Jahren
feature_stenography.md af37bb2f78 Fix some of the more obvious typos vor 8 Jahren
feature_swap_hands.md 7b80aea8b2 Add back docs for hand-swapping feature. vor 7 Jahren
feature_tap_dance.md bb53635f33 Trim trailing whitespace vor 8 Jahren
feature_terminal.md bb53635f33 Trim trailing whitespace vor 8 Jahren
feature_thermal_printer.md 4c675a83ba Format keycode tables vor 8 Jahren
feature_unicode.md af37bb2f78 Fix some of the more obvious typos vor 8 Jahren
feature_userspace.md bb53635f33 Trim trailing whitespace vor 8 Jahren
features.md af37bb2f78 Fix some of the more obvious typos vor 8 Jahren
flashing.md bb53635f33 Trim trailing whitespace vor 8 Jahren
fuse.txt ca01d94005 convert docs to lowercase and underscores vor 8 Jahren
getting_started_build_tools.md 767f7a8cf0 Fixed formatting for Fedora example vor 7 Jahren
getting_started_getting_help.md 08e48eb6f5 Add a newbie guide for people completely new to QMK (#2480) vor 7 Jahren
getting_started_github.md 7b0356d1d4 Convert all headings to Title Case vor 8 Jahren
getting_started_introduction.md 7b0356d1d4 Convert all headings to Title Case vor 8 Jahren
getting_started_make_guide.md bb53635f33 Trim trailing whitespace vor 8 Jahren
getting_started_vagrant.md af37bb2f78 Fix some of the more obvious typos vor 8 Jahren
glossary.md 7f7f763598 Fixed dead links (#2451) vor 7 Jahren
hand_wire.md bb53635f33 Trim trailing whitespace vor 8 Jahren
hardware.md af37bb2f78 Fix some of the more obvious typos vor 8 Jahren
hardware_avr.md 4931510ad3 backlight breathing overhaul (#2187) vor 8 Jahren
hardware_drivers.md 7b0356d1d4 Convert all headings to Title Case vor 8 Jahren
hardware_keyboard_guidelines.md b36b4382d0 Mention invalid names in the readme. (#2458) vor 7 Jahren
how_keyboards_work.md 7b0356d1d4 Convert all headings to Title Case vor 8 Jahren
isp_flashing_guide.md bb53635f33 Trim trailing whitespace vor 8 Jahren
keycode.txt bb53635f33 Trim trailing whitespace vor 8 Jahren
keycodes.md 8e99fbc884 Fixed typo of 'confid.h' to 'config.h' (#2448) vor 7 Jahren
keycodes_basic.md 4c675a83ba Format keycode tables vor 8 Jahren
keycodes_us_ansi_shifted.md bb53635f33 Trim trailing whitespace vor 8 Jahren
keymap.md 8df2ee4ec3 Minor updates to docs (#2406) vor 7 Jahren
newbs.md 48e11240a6 Move the linux tutorials to an info box on newbs_getting_started vor 7 Jahren
newbs_building_firmware.md 75354f12d7 warn->danger vor 7 Jahren
newbs_flashing.md 08e48eb6f5 Add a newbie guide for people completely new to QMK (#2480) vor 7 Jahren
newbs_getting_started.md 48e11240a6 Move the linux tutorials to an info box on newbs_getting_started vor 7 Jahren
newbs_testing_debugging.md 08e48eb6f5 Add a newbie guide for people completely new to QMK (#2480) vor 7 Jahren
porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md af37bb2f78 Fix some of the more obvious typos vor 8 Jahren
power.txt bb53635f33 Trim trailing whitespace vor 8 Jahren
quantum_keycodes.md bb53635f33 Trim trailing whitespace vor 8 Jahren
redirects.json 08e48eb6f5 Add a newbie guide for people completely new to QMK (#2480) vor 7 Jahren
understanding_qmk.md 7f7f763598 Fixed dead links (#2451) vor 7 Jahren
unit_testing.md bb53635f33 Trim trailing whitespace vor 8 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.