Domovská stránka Prehľadávať Pomoc
Prihlásiť sa
Tankernn
/
qmk_firmware
1
0
Fork 0
Súbory Issues 0 Pull requesty 0 Wiki
Strom: d8f0faabda
Branche Tagy
qmk_firmware
/
docs
Hugo Gayosso d8f0faabda Fixed typo 8 rokov pred
..
gitbook 4580d3a730 RGB improvements (#1684) 8 rokov pred
README.md 7b0356d1d4 Convert all headings to Title Case 8 rokov pred
_summary.md 7b0356d1d4 Convert all headings to Title Case 8 rokov pred
becoming_a_qmk_collaborator.md 7b0356d1d4 Convert all headings to Title Case 8 rokov pred
compatible_microcontrollers.md 7b0356d1d4 Convert all headings to Title Case 8 rokov pred
config_options.md af37bb2f78 Fix some of the more obvious typos 8 rokov pred
contributing.md bb53635f33 Trim trailing whitespace 8 rokov pred
custom_quantum_functions.md d8f0faabda Fixed typo 8 rokov pred
documentation_best_practices.md af37bb2f78 Fix some of the more obvious typos 8 rokov pred
documentation_templates.md 800ec55dfc Make arguments redo, subproject elimination (#1784) 8 rokov pred
eclipse.md 7b0356d1d4 Convert all headings to Title Case 8 rokov pred
faq.md e6c638bed1 Overhaul the Getting Started section and add a FAQ section 8 rokov pred
faq_build.md bb53635f33 Trim trailing whitespace 8 rokov pred
faq_debug.md bb53635f33 Trim trailing whitespace 8 rokov pred
faq_general.md 7b0356d1d4 Convert all headings to Title Case 8 rokov pred
faq_keymap.md bb53635f33 Trim trailing whitespace 8 rokov pred
feature_advanced_keycodes.md bb53635f33 Trim trailing whitespace 8 rokov pred
feature_audio.md bb53635f33 Trim trailing whitespace 8 rokov pred
feature_auto_shift.md af37bb2f78 Fix some of the more obvious typos 8 rokov pred
feature_backlight.md 4c675a83ba Format keycode tables 8 rokov pred
feature_bluetooth.md 4c675a83ba Format keycode tables 8 rokov pred
feature_bootmagic.md 4c675a83ba Format keycode tables 8 rokov pred
feature_dynamic_macros.md bb53635f33 Trim trailing whitespace 8 rokov pred
feature_grave_esc.md 4c675a83ba Format keycode tables 8 rokov pred
feature_key_lock.md 7b0356d1d4 Convert all headings to Title Case 8 rokov pred
feature_layouts.md bb53635f33 Trim trailing whitespace 8 rokov pred
feature_leader_key.md 7b0356d1d4 Convert all headings to Title Case 8 rokov pred
feature_macros.md bb53635f33 Trim trailing whitespace 8 rokov pred
feature_mouse_keys.md af37bb2f78 Fix some of the more obvious typos 8 rokov pred
feature_pointing_device.md af37bb2f78 Fix some of the more obvious typos 8 rokov pred
feature_ps2_mouse.md bb53635f33 Trim trailing whitespace 8 rokov pred
feature_rgblight.md 4c675a83ba Format keycode tables 8 rokov pred
feature_space_cadet.md af37bb2f78 Fix some of the more obvious typos 8 rokov pred
feature_space_shift_cadet.md 8a1e656099 new planck keymap, new feature - hybrid shift/enter action key (great for small keyboards!) (#2100) 8 rokov pred
feature_stenography.md af37bb2f78 Fix some of the more obvious typos 8 rokov pred
feature_tap_dance.md bb53635f33 Trim trailing whitespace 8 rokov pred
feature_terminal.md bb53635f33 Trim trailing whitespace 8 rokov pred
feature_thermal_printer.md 4c675a83ba Format keycode tables 8 rokov pred
feature_unicode.md af37bb2f78 Fix some of the more obvious typos 8 rokov pred
feature_userspace.md bb53635f33 Trim trailing whitespace 8 rokov pred
features.md af37bb2f78 Fix some of the more obvious typos 8 rokov pred
flashing.md bb53635f33 Trim trailing whitespace 8 rokov pred
fuse.txt ca01d94005 convert docs to lowercase and underscores 8 rokov pred
getting_started_build_tools.md bb53635f33 Trim trailing whitespace 8 rokov pred
getting_started_github.md 7b0356d1d4 Convert all headings to Title Case 8 rokov pred
getting_started_introduction.md 7b0356d1d4 Convert all headings to Title Case 8 rokov pred
getting_started_make_guide.md bb53635f33 Trim trailing whitespace 8 rokov pred
getting_started_vagrant.md af37bb2f78 Fix some of the more obvious typos 8 rokov pred
glossary.md bb53635f33 Trim trailing whitespace 8 rokov pred
hand_wire.md bb53635f33 Trim trailing whitespace 8 rokov pred
hardware.md af37bb2f78 Fix some of the more obvious typos 8 rokov pred
hardware_avr.md af37bb2f78 Fix some of the more obvious typos 8 rokov pred
hardware_drivers.md 7b0356d1d4 Convert all headings to Title Case 8 rokov pred
hardware_keyboard_guidelines.md bb53635f33 Trim trailing whitespace 8 rokov pred
how_keyboards_work.md 7b0356d1d4 Convert all headings to Title Case 8 rokov pred
isp_flashing_guide.md bb53635f33 Trim trailing whitespace 8 rokov pred
keycode.txt bb53635f33 Trim trailing whitespace 8 rokov pred
keycodes.md 4c675a83ba Format keycode tables 8 rokov pred
keycodes_basic.md 4c675a83ba Format keycode tables 8 rokov pred
keycodes_us_ansi_shifted.md bb53635f33 Trim trailing whitespace 8 rokov pred
keymap.md bb53635f33 Trim trailing whitespace 8 rokov pred
porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md af37bb2f78 Fix some of the more obvious typos 8 rokov pred
power.txt bb53635f33 Trim trailing whitespace 8 rokov pred
quantum_keycodes.md bb53635f33 Trim trailing whitespace 8 rokov pred
redirects.json 67cc5cebc0 Restructure the hardware and feature docs to make things easier to find (#1888) 8 rokov pred
understanding_qmk.md bb53635f33 Trim trailing whitespace 8 rokov pred
unit_testing.md bb53635f33 Trim trailing whitespace 8 rokov pred
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores 8 rokov pred

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.