Начало Каталог Помощ
Вход
Tankernn
/
qmk_firmware
1
0
Разклонения 0
Файлове Задачи 0 Заявки за сливане 0 Уики
ИН на ревизия: c12f19107f
Клонове Маркери
qmk_firmware
/
docs
skullY c12f19107f update the summary преди 8 години
..
features 391eae97e4 testing out new home преди 8 години
gitbook 704794bae3 subtree docs преди 8 години
README.md d8e29b53fe Update a bunch of docs преди 8 години
_summary.md c12f19107f update the summary преди 8 години
adding_a_keyboard_to_qmk.md 7b3c9cc8de Create adding_a_keyboard_to_qmk.md преди 8 години
adding_features_to_qmk.md d8e29b53fe Update a bunch of docs преди 8 години
basic_how_keyboards_work.md dff5708b07 update basic_how_keyboards_work преди 8 години
basic_keycodes.md d5244c6cf4 restructure keycode docs преди 8 години
becoming_a_qmk_collaborator.md ca01d94005 convert docs to lowercase and underscores преди 8 години
build_environment_setup.md d8e29b53fe Update a bunch of docs преди 8 години
build_guide.md ca01d94005 convert docs to lowercase and underscores преди 8 години
build_old.md ca01d94005 convert docs to lowercase and underscores преди 8 години
compatible_microcontrollers.md ca01d94005 convert docs to lowercase and underscores преди 8 години
config_options.md 40d82906cb adds config options md преди 8 години
custom_quantum_functions.md d8e29b53fe Update a bunch of docs преди 8 години
cygwin_guide.md ca01d94005 convert docs to lowercase and underscores преди 8 години
documentation_best_practices.md 435f99916c Work around quoting hell преди 8 години
dynamic_macros.md ca01d94005 convert docs to lowercase and underscores преди 8 години
eclipse.md d8e29b53fe Update a bunch of docs преди 8 години
embedding.md ca01d94005 convert docs to lowercase and underscores преди 8 години
faq.md 6b0503b20d update the faq преди 8 години
faq_build.md d8e29b53fe Update a bunch of docs преди 8 години
faq_keymap.md d8e29b53fe Update a bunch of docs преди 8 години
fuse.txt ca01d94005 convert docs to lowercase and underscores преди 8 години
git_subtree.md ca01d94005 convert docs to lowercase and underscores преди 8 години
glossary.md d8e29b53fe Update a bunch of docs преди 8 години
hand_wire.md ff47ca7a46 update hand_wire преди 8 години
hhkb_alt_controller.md ca01d94005 convert docs to lowercase and underscores преди 8 години
how_to_github.md 9f643ba8bf clean-up github page преди 8 години
isp_flashing_guide.md c208a6d4e5 update docs for isp преди 8 години
key_functions.md d8e29b53fe Update a bunch of docs преди 8 години
keycode.txt d9f95c5da9 Docfix (#1377) преди 8 години
keycodes.md d5244c6cf4 restructure keycode docs преди 8 години
keymap.md ca01d94005 convert docs to lowercase and underscores преди 8 години
keymap_config_h_example.h 7e84b0e3b3 move old doc to docs преди 8 години
keymap_examples.md ca01d94005 convert docs to lowercase and underscores преди 8 години
keymap_makefile_example.mk 7e84b0e3b3 move old doc to docs преди 8 години
keymap_old.md 7e84b0e3b3 move old doc to docs преди 8 години
kiibohd.asciidoc ca01d94005 convert docs to lowercase and underscores преди 8 години
leader_key.md ca01d94005 convert docs to lowercase and underscores преди 8 години
license_clarification.md ca01d94005 convert docs to lowercase and underscores преди 8 години
license_clarification_details.md ca01d94005 convert docs to lowercase and underscores преди 8 години
macros.md d8e29b53fe Update a bunch of docs преди 8 години
make_instructions.md d8e29b53fe Update a bunch of docs преди 8 години
mbed_cortex_porting.md ca01d94005 convert docs to lowercase and underscores преди 8 години
memory_write_error,_use_debug_for_more_info.md c208a6d4e5 update docs for isp преди 8 години
modding_your_keyboard.md ea7590c894 add new arguements, docs преди 8 години
mouse_keys.md b22220532f Rewrite mouse_keys to resolve #937 преди 8 години
other_projects.md 7e84b0e3b3 move old doc to docs преди 8 години
pcb_guide.md 995c3141a6 convert docs to lowercase and underscores преди 8 години
porting_your_keyboard_to_qmk.md f32c68ee65 Update porting_your_keyboard_to_qmk.md преди 8 години
porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md 995c3141a6 convert docs to lowercase and underscores преди 8 години
power.txt 995c3141a6 convert docs to lowercase and underscores преди 8 години
previously_asked_questions.asciidoc 995c3141a6 convert docs to lowercase and underscores преди 8 години
qmk_overview.md 995c3141a6 convert docs to lowercase and underscores преди 8 години
quantum_keycodes.md d8e29b53fe Update a bunch of docs преди 8 години
report_descriptor.md 995c3141a6 convert docs to lowercase and underscores преди 8 години
space_cadet_shift.md 995c3141a6 convert docs to lowercase and underscores преди 8 години
tap_dance.md d8e29b53fe Update a bunch of docs преди 8 години
test_for_asciidoc.asciidoc 995c3141a6 convert docs to lowercase and underscores преди 8 години
tmk_based_projects.md 995c3141a6 convert docs to lowercase and underscores преди 8 години
tmk_own_projects.md 995c3141a6 convert docs to lowercase and underscores преди 8 години
tmk_readme.md 995c3141a6 convert docs to lowercase and underscores преди 8 години
understanding_qmk.md d8e29b53fe Update a bunch of docs преди 8 години
unicode_and_additional_language_support.md 2abff258b1 Adjust headings on unicode преди 8 години
unit_testing.md 995c3141a6 convert docs to lowercase and underscores преди 8 години
usb_hid.md 995c3141a6 convert docs to lowercase and underscores преди 8 години
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores преди 8 години
vagrant_guide.md 0ded95b888 Update the vagrant guide преди 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), 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.