Halaman utama Jelajahi Bantuan
Masuk
Tankernn
/
qmk_firmware
1
0
Fork 0
Berkas Masalah 0 Permintaan Tarik 0 Wiki
Pohon: 6bdf7482b1
Ranting Tag
qmk_firmware
/
docs
Jack Humbert 6bdf7482b1 update audio/music documentation 8 tahun lalu
..
gitbook 704794bae3 subtree docs 8 tahun lalu
README.md d8e29b53fe Update a bunch of docs 8 tahun lalu
_summary.md 14c5160b1a Update _summary.md 8 tahun lalu
adding_a_keyboard_to_qmk.md 7b3c9cc8de Create adding_a_keyboard_to_qmk.md 8 tahun lalu
adding_features_to_qmk.md d8e29b53fe Update a bunch of docs 8 tahun lalu
basic_how_keyboards_work.md dff5708b07 update basic_how_keyboards_work 8 tahun lalu
basic_keycodes.md d5244c6cf4 restructure keycode docs 8 tahun lalu
becoming_a_qmk_collaborator.md ca01d94005 convert docs to lowercase and underscores 8 tahun lalu
build_environment_setup.md d8e29b53fe Update a bunch of docs 8 tahun lalu
compatible_microcontrollers.md ca01d94005 convert docs to lowercase and underscores 8 tahun lalu
config_options.md 40d82906cb adds config options md 8 tahun lalu
custom_quantum_functions.md d8e29b53fe Update a bunch of docs 8 tahun lalu
documentation_best_practices.md 435f99916c Work around quoting hell 8 tahun lalu
dynamic_macros.md ca01d94005 convert docs to lowercase and underscores 8 tahun lalu
eclipse.md d8e29b53fe Update a bunch of docs 8 tahun lalu
faq.md 6b0503b20d update the faq 8 tahun lalu
faq_build.md d8e29b53fe Update a bunch of docs 8 tahun lalu
faq_keymap.md d8e29b53fe Update a bunch of docs 8 tahun lalu
features.md 000e749853 Rename docs/features/README.md to docs/features.md 8 tahun lalu
fuse.txt ca01d94005 convert docs to lowercase and underscores 8 tahun lalu
glossary.md d8e29b53fe Update a bunch of docs 8 tahun lalu
hand_wire.md ff47ca7a46 update hand_wire 8 tahun lalu
how_to_github.md 9f643ba8bf clean-up github page 8 tahun lalu
isp_flashing_guide.md c208a6d4e5 update docs for isp 8 tahun lalu
key_functions.md d8e29b53fe Update a bunch of docs 8 tahun lalu
keycode.txt d9f95c5da9 Docfix (#1377) 8 tahun lalu
keycodes.md d5244c6cf4 restructure keycode docs 8 tahun lalu
keymap.md ca01d94005 convert docs to lowercase and underscores 8 tahun lalu
leader_key.md ca01d94005 convert docs to lowercase and underscores 8 tahun lalu
macros.md ecd3dbf085 Merge branch 'master' into docs 8 tahun lalu
make_instructions.md d8e29b53fe Update a bunch of docs 8 tahun lalu
modding_your_keyboard.md 6bdf7482b1 update audio/music documentation 8 tahun lalu
mouse_keys.md ecd3dbf085 Merge branch 'master' into docs 8 tahun lalu
porting_your_keyboard_to_qmk.md f32c68ee65 Update porting_your_keyboard_to_qmk.md 8 tahun lalu
porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md 995c3141a6 convert docs to lowercase and underscores 8 tahun lalu
power.txt 995c3141a6 convert docs to lowercase and underscores 8 tahun lalu
qmk_overview.md 995c3141a6 convert docs to lowercase and underscores 8 tahun lalu
quantum_keycodes.md 03eb6a3e86 comment out unformatted audio/midi sections 8 tahun lalu
space_cadet_shift.md 995c3141a6 convert docs to lowercase and underscores 8 tahun lalu
tap_dance.md d8e29b53fe Update a bunch of docs 8 tahun lalu
understanding_qmk.md d8e29b53fe Update a bunch of docs 8 tahun lalu
unicode.md 9cadba7b89 Add missing files to _summary.md 8 tahun lalu
unit_testing.md 995c3141a6 convert docs to lowercase and underscores 8 tahun lalu
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores 8 tahun lalu
vagrant_guide.md 0ded95b888 Update the vagrant guide 8 tahun lalu

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.