ホーム エクスプローラ ヘルプ
登録 サインイン
HuiJun
/
qmk_firmware
1
0
フォーク 0
ファイル 課題 0 プルリクエスト 0 Wiki
ツリー: f5422a70b6
ブランチ タグ
qmk_firmware
/
docs
Colin T.A. Gray 53b043d4ef adds 'RGB_RMOD' to go through RGB modes in reverse 7 年 前
..
gitbook 4580d3a730 RGB improvements (#1684) 7 年 前
README.md 800ec55dfc Make arguments redo, subproject elimination (#1784) 7 年 前
_summary.md 0b54e7f5ae Flesh out the grave escape overrides 7 年 前
becoming_a_qmk_collaborator.md ca01d94005 convert docs to lowercase and underscores 8 年 前
compatible_microcontrollers.md ca01d94005 convert docs to lowercase and underscores 8 年 前
config_options.md 62eed0e4a3 Update config_options.md 7 年 前
contributing.md 7aaef16266 Fix internal links in docs/ (#2080) 7 年 前
custom_quantum_functions.md 7aaef16266 Fix internal links in docs/ (#2080) 7 年 前
documentation_best_practices.md 9d1a08e38a Doc updates from going through every file 7 年 前
documentation_templates.md 800ec55dfc Make arguments redo, subproject elimination (#1784) 7 年 前
eclipse.md d8e29b53fe Update a bunch of docs 8 年 前
faq.md e6c638bed1 Overhaul the Getting Started section and add a FAQ section 7 年 前
faq_build.md 7aaef16266 Fix internal links in docs/ (#2080) 7 年 前
faq_debug.md 392121b10e Document the Teensy hardware reset problem 7 年 前
faq_general.md 32bb8f6b8a Improvements to documentation (#1919) 7 年 前
faq_keymap.md 0b54e7f5ae Flesh out the grave escape overrides 7 年 前
feature_advanced_keycodes.md 0740e84d63 update advanced_keycodes; oneshot = sticky/dead keys 7 年 前
feature_audio.md 9d1a08e38a Doc updates from going through every file 7 年 前
feature_auto_shift.md 245b3376d6 Correct the rules.mk documentation for auto shift. 7 年 前
feature_backlight.md 9b879b1267 break up keymaps and quantum keycodes into files by feature 7 年 前
feature_bluetooth.md 9d1a08e38a Doc updates from going through every file 7 年 前
feature_bootmagic.md 29bcffb3f3 Edited a minor typo in feature_bootmagic.md. 7 年 前
feature_dynamic_macros.md 67cc5cebc0 Restructure the hardware and feature docs to make things easier to find (#1888) 7 年 前
feature_grave_esc.md 0b54e7f5ae Flesh out the grave escape overrides 7 年 前
feature_key_lock.md 7aaef16266 Fix internal links in docs/ (#2080) 7 年 前
feature_layouts.md c8bdc75e1d Update feature_layouts.md 7 年 前
feature_leader_key.md 9d1a08e38a Doc updates from going through every file 7 年 前
feature_macros.md 7ff96877d2 added SS_LSFT to featured macros 7 年 前
feature_mouse_keys.md 67cc5cebc0 Restructure the hardware and feature docs to make things easier to find (#1888) 7 年 前
feature_pointing_device.md ee13228486 Generic Pointing Device (#1767) 7 年 前
feature_ps2_mouse.md 966e2660cf Add option to reverse PS2 mouse axes and scrolling 7 年 前
feature_rgblight.md 53b043d4ef adds 'RGB_RMOD' to go through RGB modes in reverse 7 年 前
feature_space_cadet.md 67cc5cebc0 Restructure the hardware and feature docs to make things easier to find (#1888) 7 年 前
feature_stenography.md bf1fedc05e Fixed various feature links 7 年 前
feature_tap_dance.md 4c1164c469 fixed two typos 7 年 前
feature_terminal.md 7ad924bae5 Updates send_string functionality, adds terminal feature (#1657) 7 年 前
feature_thermal_printer.md 9b879b1267 break up keymaps and quantum keycodes into files by feature 7 年 前
feature_unicode.md 67cc5cebc0 Restructure the hardware and feature docs to make things easier to find (#1888) 7 年 前
feature_userspace.md 28874a9f33 Fixed minor typo in bootloader code 7 年 前
features.md 7aaef16266 Fix internal links in docs/ (#2080) 7 年 前
flashing.md 9fdc276260 Updates bootloader settings, adds file size check (#2029) 7 年 前
fuse.txt ca01d94005 convert docs to lowercase and underscores 8 年 前
getting_started_build_tools.md 32bb8f6b8a Improvements to documentation (#1919) 7 年 前
getting_started_github.md d069a42c07 Update getting_started_github.md 7 年 前
getting_started_introduction.md bb11df6b7a update some docs 7 年 前
getting_started_make_guide.md 7b51f050d7 Fix typo in make example 7 年 前
getting_started_vagrant.md bb11df6b7a update some docs 7 年 前
glossary.md c917888262 update glossary; oneshot key = sticky/dead key 7 年 前
hand_wire.md 309a400b3e Update hand_wire.md 7 年 前
hardware.md 67cc5cebc0 Restructure the hardware and feature docs to make things easier to find (#1888) 7 年 前
hardware_avr.md 67cc5cebc0 Restructure the hardware and feature docs to make things easier to find (#1888) 7 年 前
hardware_drivers.md 67cc5cebc0 Restructure the hardware and feature docs to make things easier to find (#1888) 7 年 前
hardware_keyboard_guidelines.md 535c2f60a9 use real greater than and less than chars 7 年 前
how_keyboards_work.md 9fed4f7948 Add link to keycodes doc in how_keyboards_work 7 年 前
isp_flashing_guide.md c208a6d4e5 update docs for isp 8 年 前
keycode.txt d9f95c5da9 Docfix (#1377) 8 年 前
keycodes.md 4df4fa7c26 Clarify `KC_PWR` vs `KC_POWER`. Fixes #1994. 7 年 前
keycodes_basic.md c8d365f5da platform descriptions to match master keycodes.md documentation 7 年 前
keycodes_us_ansi_shifted.md 9b879b1267 break up keymaps and quantum keycodes into files by feature 7 年 前
keymap.md b9f426ae1e Fix broken link in docs 7 年 前
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 年 前
quantum_keycodes.md 67cc5cebc0 Restructure the hardware and feature docs to make things easier to find (#1888) 7 年 前
redirects.json 67cc5cebc0 Restructure the hardware and feature docs to make things easier to find (#1888) 7 年 前
understanding_qmk.md 7aaef16266 Fix internal links in docs/ (#2080) 7 年 前
unit_testing.md 800ec55dfc Make arguments redo, subproject elimination (#1784) 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.