ホーム エクスプローラ ヘルプ
サインイン
Tankernn
/
qmk_firmware
1
0
フォーク 0
ファイル 課題 0 プルリクエスト 0 Wiki
ツリー: 911b2d0756
ブランチ タグ
qmk_firmware
/
docs
KOBAYASHI Daisuke 911b2d0756 Docs: Fix descriptions of KC_INT1 and KC_INT3 7 年 前
..
gitbook 4580d3a730 RGB improvements (#1684) 8 年 前
.nojekyll 9e5676650e Use docsfy to replace gitbook 7 年 前
CNAME 4d26137e2a Create CNAME 7 年 前
README.md 73ddb764cc Fix readme and contributing hyperlinks 7 年 前
_sidebar.md 4083614023 I2C driver docs (#4298) 7 年 前
_summary.md 4083614023 I2C driver docs (#4298) 7 年 前
arm_debugging.md ac7b2d92bf ARM SWD guide 7 年 前
becoming_a_qmk_collaborator.md 1acaf2b2c2 Tweak the wording in "Becoming a QMK Collaborator" 7 年 前
compatible_microcontrollers.md 7b0356d1d4 Convert all headings to Title Case 8 年 前
config_options.md 6729265625 Clarify the Mod Tap defines in documentation (#4352) 7 年 前
contributing.md 7458ac9489 Update Contrib doc (#4068) 7 年 前
custom_quantum_functions.md d81d216d72 Fix Typo in Custom Quantum functions document (led_state) (#4129) 7 年 前
documentation_best_practices.md 303f425c6b Fix up info boxes. 7 年 前
documentation_templates.md 8454fa5e9f Update Document Templates to reflect newer wording and URLs (#4006) 7 年 前
eclipse.md 8e99fbc884 Fixed typo of 'confid.h' to 'config.h' (#2448) 7 年 前
faq.md e6c638bed1 Overhaul the Getting Started section and add a FAQ section 8 年 前
faq_build.md b1e74aee43 Make sure that avr-gcc@7 gets linked into the path on MacOS. 7 年 前
faq_debug.md bb53635f33 Trim trailing whitespace 8 年 前
faq_general.md 7b0356d1d4 Convert all headings to Title Case 8 年 前
faq_keymap.md bfc9aa66f9 Docs: Update image in FAQ/Keymap: KC_EQLS -> KC_EQL (#3660) 7 年 前
feature_advanced_keycodes.md 6729265625 Clarify the Mod Tap defines in documentation (#4352) 7 年 前
feature_audio.md a0309db983 Add On/Off keycodes 7 年 前
feature_auto_shift.md 303f425c6b Fix up info boxes. 7 年 前
feature_backlight.md fa1ac4d724 Fix incorrect doctoring in feature.backlight.md (#4244) 7 年 前
feature_bluetooth.md 914d42acd0 Update Bluetooth docs (#4062) 7 年 前
feature_bootmagic.md 7373d5b394 Update feature_bootmagic.md (#4290) 7 年 前
feature_combo.md 26a201e687 fix example to reflect caveat 7 年 前
feature_command.md 25d757284c Docs: Fix Command docs escaping (#3523) 7 年 前
feature_dynamic_macros.md 6caea0acfb Docs: Adjust dynamic macro docs to include more than the planck (#3509) 7 年 前
feature_encoders.md 24b3556e84 add better example 7 年 前
feature_grave_esc.md 2bc34b09cd Docs: Format Grave Escape documentation (#3536) 7 年 前
feature_hd44780.md bbea9dadbc Integrating Peter Fleury's HD44780 LCD library (#3209) 7 年 前
feature_key_lock.md c11a26ba54 Docs: Format Key Lock documentation (#3538) 7 年 前
feature_layouts.md 08c682c193 Docs: Add docs for the `LAYOUT_*` macro to layouts (#3772) 7 年 前
feature_leader_key.md 244e1c5a57 Fix LEADER_KEY docs. 7 年 前
feature_macros.md 26f4e7031a Add tap_code function (#3784) 7 年 前
feature_mouse_keys.md 7f7f763598 Fixed dead links (#2451) 7 年 前
feature_pointing_device.md af37bb2f78 Fix some of the more obvious typos 8 年 前
feature_ps2_mouse.md 58b9b22670 Circuitry sample for PS/2 Mouse (#3959) 7 年 前
feature_rgb_matrix.md da6c58175a Make digital rain RGB matrix effect #define configurable. 7 年 前
feature_rgblight.md 94f58322ac Configurable Rainbow Swirl range (#4376) 7 年 前
feature_space_cadet_shift.md 03ad6927cb Docs: Format Space Cadet documentation (#3540) 7 年 前
feature_space_cadet_shift_enter.md 03ad6927cb Docs: Format Space Cadet documentation (#3540) 7 年 前
feature_stenography.md c0baf2a964 Improve state/chord handling and clean up namespace 7 年 前
feature_swap_hands.md fd085837e1 fix swap_hands keycodes in documentation (#3588) 7 年 前
feature_tap_dance.md d210ac7a3e Add caveat for basic keycodes in Tap Dance docs 7 年 前
feature_terminal.md 5112af887a Added command history to terminal with other bug fixes, added new song to song_list.h (#2855) 7 年 前
feature_thermal_printer.md 4c675a83ba Format keycode tables 8 年 前
feature_unicode.md 5a127293e7 Fix formatting in Unicode text 7 年 前
feature_userspace.md f1b2d46eaf Spell-check update for Userspace documentation 7 年 前
features.md 2dc14d1cb3 Fixed incorrect link to feature_combo.md in features.md docs file. Was linked to feature_combos.md, but _sidebar.md, _summary.md, and config_options.md all link to feature_combo.md. Assuming that it should not be pluralized. (#4411) 7 年 前
flashing.md 292a87ad04 Instructions on how to flash via STM32 bootloader (#4316) 7 年 前
fuse.txt ca01d94005 convert docs to lowercase and underscores 8 年 前
getting_started_build_tools.md b1e74aee43 Make sure that avr-gcc@7 gets linked into the path on MacOS. 7 年 前
getting_started_getting_help.md 48913153c3 Replace gitter links with Discord. (#3368) 7 年 前
getting_started_github.md 76aa2baf3e Fix doc typo 7 年 前
getting_started_introduction.md c5c112ae29 Update config.h boilerplate to use `#pragma once` 7 年 前
getting_started_make_guide.md 0fab3bbde3 Lets split eh (#3120) 7 年 前
getting_started_vagrant.md af37bb2f78 Fix some of the more obvious typos 8 年 前
hand_wire.md bb53635f33 Trim trailing whitespace 8 年 前
hardware.md af37bb2f78 Fix some of the more obvious typos 8 年 前
hardware_avr.md ab3fbfdb3b Update hardware config warnings to be more accurate 7 年 前
hardware_drivers.md fdd0f91527 ISSI31FL3733 driver (#3679) 7 年 前
hardware_keyboard_guidelines.md 9fb1e5d171 Remove bootloader key as it is no longer used (#3093) 7 年 前
how_keyboards_work.md d08f9cb6e4 Fix grammar, typos, and the link to HID specification 7 年 前
i2c_driver.md caa293a8f7 Remove duplicate row from Available functions table in i2c_driver doc (#4416) 7 年 前
index.html 7d49a17781 override hamburger placement 7 年 前
internals_defines.md ae7284edb8 rename api docs to internals 7 年 前
internals_gpio_control.md 15f6278aa6 Add support for Atmega32A to pin declarations and universal matrix (#4015) 7 年 前
internals_input_callback_reg.md ae7284edb8 rename api docs to internals 7 年 前
internals_midi_device.md ae7284edb8 rename api docs to internals 7 年 前
internals_midi_device_setup_process.md ae7284edb8 rename api docs to internals 7 年 前
internals_midi_util.md ae7284edb8 rename api docs to internals 7 年 前
internals_send_functions.md ae7284edb8 rename api docs to internals 7 年 前
internals_sysex_tools.md ae7284edb8 rename api docs to internals 7 年 前
isp_flashing_guide.md ac46378ac6 Update ISP flashing guide with pre-compiled binary (#3217) 7 年 前
keycode.txt bb53635f33 Trim trailing whitespace 8 年 前
keycodes.md 911b2d0756 Docs: Fix descriptions of KC_INT1 and KC_INT3 7 年 前
keycodes_basic.md 911b2d0756 Docs: Fix descriptions of KC_INT1 and KC_INT3 7 年 前
keycodes_us_ansi_shifted.md 9374c0c9db Add caveats for shifted characters (#4192) 7 年 前
keymap.md 334e2629df Remove redefinition of `_______` in documentation example (#3924) 7 年 前
newbs.md 480651cf9d Docs: Adding QMK Git Conventions doc; formatting cleanup on Learning Resources doc (#3902) 7 年 前
newbs_best_practices.md 480651cf9d Docs: Adding QMK Git Conventions doc; formatting cleanup on Learning Resources doc (#3902) 7 年 前
newbs_building_firmware.md a5b10e5da2 Fix syntax for windows 7 年 前
newbs_flashing.md 303f425c6b Fix up info boxes. 7 年 前
newbs_getting_started.md 3dec80b774 Improve wording, punctuation and capitalization in newbs_getting_started guide (#4342) 7 年 前
newbs_learn_more_resources.md 480651cf9d Docs: Adding QMK Git Conventions doc; formatting cleanup on Learning Resources doc (#3902) 7 年 前
newbs_testing_debugging.md 08e48eb6f5 Add a newbie guide for people completely new to QMK (#2480) 7 年 前
porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md af37bb2f78 Fix some of the more obvious typos 8 年 前
power.txt bb53635f33 Trim trailing whitespace 8 年 前
qmk.css ccc87421e7 Some more tweaks to make everything look nice 7 年 前
quantum_keycodes.md 6e44f94f21 Add EEPROM_RESET keycode to core code (#4234) 7 年 前
redirects.json 03ad6927cb Docs: Format Space Cadet documentation (#3540) 7 年 前
ref_functions.md 7e1b57add4 Some cleanup of the Useful Functions docs (#4064) 7 年 前
reference_glossary.md dad79cafcd Fix more broken links to the HID spec 7 年 前
sidebar.css 7d49a17781 override hamburger placement 7 年 前
sw.js 303f425c6b Fix up info boxes. 7 年 前
understanding_qmk.md 743449472e Make `PREVENT_STUCK_MODIFIERS` the default (#3107) 7 年 前
unit_testing.md bb53635f33 Trim trailing whitespace 8 年 前
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores 8 年 前

README.md

Quantum Mechanical Keyboard Firmware

Current Version Build Status Discord Docs Status GitHub contributors GitHub forks

What is QMK Firmware?

QMK (Quantum Mechanical Keyboard) is an open source community that maintains QMK Firmware, QMK Toolbox, 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

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

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

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.