Etusivu Tutki Apua
Kirjaudu sisään
Tankernn
/
qmk_firmware
1
0
Haarauta 0
Tiedostot Esitykset 0 Vetopyynnöt 0 Wiki
Puu: d8e29b53fe
Haarat Tunnisteet
qmk_firmware
/
docs
skullY d8e29b53fe Update a bunch of docs 8 vuotta sitten
..
features 391eae97e4 testing out new home 8 vuotta sitten
gitbook 704794bae3 subtree docs 8 vuotta sitten
README.md d8e29b53fe Update a bunch of docs 8 vuotta sitten
_summary.md d8e29b53fe Update a bunch of docs 8 vuotta sitten
adding_a_keyboard_to_qmk.md 7b3c9cc8de Create adding_a_keyboard_to_qmk.md 8 vuotta sitten
adding_features_to_qmk.md d8e29b53fe Update a bunch of docs 8 vuotta sitten
basic_how_keyboards_work.md 7e84b0e3b3 move old doc to docs 8 vuotta sitten
basic_keycodes.md d5244c6cf4 restructure keycode docs 8 vuotta sitten
becoming_a_qmk_collaborator.md ca01d94005 convert docs to lowercase and underscores 8 vuotta sitten
build_environment_setup.md d8e29b53fe Update a bunch of docs 8 vuotta sitten
build_guide.md ca01d94005 convert docs to lowercase and underscores 8 vuotta sitten
build_old.md ca01d94005 convert docs to lowercase and underscores 8 vuotta sitten
compatible_microcontrollers.md ca01d94005 convert docs to lowercase and underscores 8 vuotta sitten
config_options.md 40d82906cb adds config options md 8 vuotta sitten
custom_quantum_functions.md d8e29b53fe Update a bunch of docs 8 vuotta sitten
cygwin_guide.md ca01d94005 convert docs to lowercase and underscores 8 vuotta sitten
documentation_best_practices.md d8e29b53fe Update a bunch of docs 8 vuotta sitten
dynamic_macros.md ca01d94005 convert docs to lowercase and underscores 8 vuotta sitten
eclipse.md d8e29b53fe Update a bunch of docs 8 vuotta sitten
embedding.md ca01d94005 convert docs to lowercase and underscores 8 vuotta sitten
faq.md d8e29b53fe Update a bunch of docs 8 vuotta sitten
faq_build.md d8e29b53fe Update a bunch of docs 8 vuotta sitten
faq_keymap.md d8e29b53fe Update a bunch of docs 8 vuotta sitten
fuse.txt ca01d94005 convert docs to lowercase and underscores 8 vuotta sitten
git_subtree.md ca01d94005 convert docs to lowercase and underscores 8 vuotta sitten
glossary.md d8e29b53fe Update a bunch of docs 8 vuotta sitten
hand_wire.md ca01d94005 convert docs to lowercase and underscores 8 vuotta sitten
hhkb_alt_controller.md ca01d94005 convert docs to lowercase and underscores 8 vuotta sitten
how_to_github.md 9f643ba8bf clean-up github page 8 vuotta sitten
isp_flashing_guide.md c208a6d4e5 update docs for isp 8 vuotta sitten
key_functions.md d8e29b53fe Update a bunch of docs 8 vuotta sitten
keycode.txt d9f95c5da9 Docfix (#1377) 8 vuotta sitten
keycodes.md d5244c6cf4 restructure keycode docs 8 vuotta sitten
keymap.md ca01d94005 convert docs to lowercase and underscores 8 vuotta sitten
keymap_config_h_example.h 7e84b0e3b3 move old doc to docs 8 vuotta sitten
keymap_examples.md ca01d94005 convert docs to lowercase and underscores 8 vuotta sitten
keymap_makefile_example.mk 7e84b0e3b3 move old doc to docs 8 vuotta sitten
keymap_old.md 7e84b0e3b3 move old doc to docs 8 vuotta sitten
kiibohd.asciidoc ca01d94005 convert docs to lowercase and underscores 8 vuotta sitten
leader_key.md ca01d94005 convert docs to lowercase and underscores 8 vuotta sitten
license_clarification.md ca01d94005 convert docs to lowercase and underscores 8 vuotta sitten
license_clarification_details.md ca01d94005 convert docs to lowercase and underscores 8 vuotta sitten
macros.md d8e29b53fe Update a bunch of docs 8 vuotta sitten
make_instructions.md d8e29b53fe Update a bunch of docs 8 vuotta sitten
mbed_cortex_porting.md ca01d94005 convert docs to lowercase and underscores 8 vuotta sitten
memory_write_error,_use_debug_for_more_info.md c208a6d4e5 update docs for isp 8 vuotta sitten
modding_your_keyboard.md ea7590c894 add new arguements, docs 8 vuotta sitten
mouse_keys.md ca01d94005 convert docs to lowercase and underscores 8 vuotta sitten
other_projects.md 7e84b0e3b3 move old doc to docs 8 vuotta sitten
pcb_guide.md 995c3141a6 convert docs to lowercase and underscores 8 vuotta sitten
porting_your_keyboard_to_qmk.md f32c68ee65 Update porting_your_keyboard_to_qmk.md 8 vuotta sitten
porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md 995c3141a6 convert docs to lowercase and underscores 8 vuotta sitten
power.txt 995c3141a6 convert docs to lowercase and underscores 8 vuotta sitten
previously_asked_questions.asciidoc 995c3141a6 convert docs to lowercase and underscores 8 vuotta sitten
qmk_overview.md 995c3141a6 convert docs to lowercase and underscores 8 vuotta sitten
quantum_keycodes.md d8e29b53fe Update a bunch of docs 8 vuotta sitten
report_descriptor.md 995c3141a6 convert docs to lowercase and underscores 8 vuotta sitten
space_cadet_shift.md 995c3141a6 convert docs to lowercase and underscores 8 vuotta sitten
tap_dance.md d8e29b53fe Update a bunch of docs 8 vuotta sitten
test_for_asciidoc.asciidoc 995c3141a6 convert docs to lowercase and underscores 8 vuotta sitten
tmk_based_projects.md 995c3141a6 convert docs to lowercase and underscores 8 vuotta sitten
tmk_own_projects.md 995c3141a6 convert docs to lowercase and underscores 8 vuotta sitten
tmk_readme.md 995c3141a6 convert docs to lowercase and underscores 8 vuotta sitten
understanding_qmk.md d8e29b53fe Update a bunch of docs 8 vuotta sitten
unicode_and_additional_language_support.md 995c3141a6 convert docs to lowercase and underscores 8 vuotta sitten
unit_testing.md 995c3141a6 convert docs to lowercase and underscores 8 vuotta sitten
usb_hid.md 995c3141a6 convert docs to lowercase and underscores 8 vuotta sitten
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores 8 vuotta sitten
vagrant_guide.md 995c3141a6 convert docs to lowercase and underscores 8 vuotta sitten

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.