Эхлэл Бүгдийг харах Тусламж
Бүртгүүлэх Нэвтрэх
HuiJun
/
qmk_firmware
1
0
Салаа 0
Файлууд Асуудлууд 0 Хуулах хүсэлтүүд 0 Мэдлэгийн сан
Мод: 4ea3bbdb4c
Салаанууд Тагууд
qmk_firmware
/
docs
Zach Richard 8a1e656099 new planck keymap, new feature - hybrid shift/enter action key (great for small keyboards!) (#2100) 7 жил өмнө
..
gitbook 4580d3a730 RGB improvements (#1684) 7 жил өмнө
README.md 7b0356d1d4 Convert all headings to Title Case 7 жил өмнө
_summary.md 7b0356d1d4 Convert all headings to Title Case 7 жил өмнө
becoming_a_qmk_collaborator.md 7b0356d1d4 Convert all headings to Title Case 7 жил өмнө
compatible_microcontrollers.md 7b0356d1d4 Convert all headings to Title Case 7 жил өмнө
config_options.md af37bb2f78 Fix some of the more obvious typos 7 жил өмнө
contributing.md bb53635f33 Trim trailing whitespace 7 жил өмнө
custom_quantum_functions.md bb53635f33 Trim trailing whitespace 7 жил өмнө
documentation_best_practices.md af37bb2f78 Fix some of the more obvious typos 7 жил өмнө
documentation_templates.md 800ec55dfc Make arguments redo, subproject elimination (#1784) 7 жил өмнө
eclipse.md 7b0356d1d4 Convert all headings to Title Case 7 жил өмнө
faq.md e6c638bed1 Overhaul the Getting Started section and add a FAQ section 7 жил өмнө
faq_build.md bb53635f33 Trim trailing whitespace 7 жил өмнө
faq_debug.md bb53635f33 Trim trailing whitespace 7 жил өмнө
faq_general.md 7b0356d1d4 Convert all headings to Title Case 7 жил өмнө
faq_keymap.md bb53635f33 Trim trailing whitespace 7 жил өмнө
feature_advanced_keycodes.md bb53635f33 Trim trailing whitespace 7 жил өмнө
feature_audio.md bb53635f33 Trim trailing whitespace 7 жил өмнө
feature_auto_shift.md af37bb2f78 Fix some of the more obvious typos 7 жил өмнө
feature_backlight.md 4c675a83ba Format keycode tables 7 жил өмнө
feature_bluetooth.md 4c675a83ba Format keycode tables 7 жил өмнө
feature_bootmagic.md 4c675a83ba Format keycode tables 7 жил өмнө
feature_dynamic_macros.md bb53635f33 Trim trailing whitespace 7 жил өмнө
feature_grave_esc.md 4c675a83ba Format keycode tables 7 жил өмнө
feature_key_lock.md 7b0356d1d4 Convert all headings to Title Case 7 жил өмнө
feature_layouts.md bb53635f33 Trim trailing whitespace 7 жил өмнө
feature_leader_key.md 7b0356d1d4 Convert all headings to Title Case 7 жил өмнө
feature_macros.md bb53635f33 Trim trailing whitespace 7 жил өмнө
feature_mouse_keys.md af37bb2f78 Fix some of the more obvious typos 7 жил өмнө
feature_pointing_device.md af37bb2f78 Fix some of the more obvious typos 7 жил өмнө
feature_ps2_mouse.md bb53635f33 Trim trailing whitespace 7 жил өмнө
feature_rgblight.md 4c675a83ba Format keycode tables 7 жил өмнө
feature_space_cadet.md af37bb2f78 Fix some of the more obvious typos 7 жил өмнө
feature_space_shift_cadet.md 8a1e656099 new planck keymap, new feature - hybrid shift/enter action key (great for small keyboards!) (#2100) 7 жил өмнө
feature_stenography.md af37bb2f78 Fix some of the more obvious typos 7 жил өмнө
feature_tap_dance.md bb53635f33 Trim trailing whitespace 7 жил өмнө
feature_terminal.md bb53635f33 Trim trailing whitespace 7 жил өмнө
feature_thermal_printer.md 4c675a83ba Format keycode tables 7 жил өмнө
feature_unicode.md af37bb2f78 Fix some of the more obvious typos 7 жил өмнө
feature_userspace.md bb53635f33 Trim trailing whitespace 7 жил өмнө
features.md af37bb2f78 Fix some of the more obvious typos 7 жил өмнө
flashing.md bb53635f33 Trim trailing whitespace 7 жил өмнө
fuse.txt ca01d94005 convert docs to lowercase and underscores 8 жил өмнө
getting_started_build_tools.md bb53635f33 Trim trailing whitespace 7 жил өмнө
getting_started_github.md 7b0356d1d4 Convert all headings to Title Case 7 жил өмнө
getting_started_introduction.md 7b0356d1d4 Convert all headings to Title Case 7 жил өмнө
getting_started_make_guide.md bb53635f33 Trim trailing whitespace 7 жил өмнө
getting_started_vagrant.md af37bb2f78 Fix some of the more obvious typos 7 жил өмнө
glossary.md bb53635f33 Trim trailing whitespace 7 жил өмнө
hand_wire.md bb53635f33 Trim trailing whitespace 7 жил өмнө
hardware.md af37bb2f78 Fix some of the more obvious typos 7 жил өмнө
hardware_avr.md af37bb2f78 Fix some of the more obvious typos 7 жил өмнө
hardware_drivers.md 7b0356d1d4 Convert all headings to Title Case 7 жил өмнө
hardware_keyboard_guidelines.md bb53635f33 Trim trailing whitespace 7 жил өмнө
how_keyboards_work.md 7b0356d1d4 Convert all headings to Title Case 7 жил өмнө
isp_flashing_guide.md bb53635f33 Trim trailing whitespace 7 жил өмнө
keycode.txt bb53635f33 Trim trailing whitespace 7 жил өмнө
keycodes.md 4c675a83ba Format keycode tables 7 жил өмнө
keycodes_basic.md 4c675a83ba Format keycode tables 7 жил өмнө
keycodes_us_ansi_shifted.md bb53635f33 Trim trailing whitespace 7 жил өмнө
keymap.md bb53635f33 Trim trailing whitespace 7 жил өмнө
porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md af37bb2f78 Fix some of the more obvious typos 7 жил өмнө
power.txt bb53635f33 Trim trailing whitespace 7 жил өмнө
quantum_keycodes.md bb53635f33 Trim trailing whitespace 7 жил өмнө
redirects.json 67cc5cebc0 Restructure the hardware and feature docs to make things easier to find (#1888) 7 жил өмнө
understanding_qmk.md bb53635f33 Trim trailing whitespace 7 жил өмнө
unit_testing.md bb53635f33 Trim trailing whitespace 7 жил өмнө
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores 8 жил өмнө

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.