Halaman utama Jelajahi Bantuan
Daftar Masuk
HuiJun
/
qmk_firmware
1
0
Fork 0
Berkas Masalah 0 Permintaan Tarik 0 Wiki
Pohon: f61c99fdda
Ranting Tag
qmk_firmware
/
docs
Konstantin Đorđević cd369b7107 docker_build.sh: Run container in interactive mode (#5088) 6 tahun lalu
..
gitbook 4580d3a730 RGB improvements (#1684) 7 tahun lalu
zh 3cf179be61 Adds Proton C Conversion (#4661) 6 tahun lalu
.nojekyll 9e5676650e Use docsfy to replace gitbook 7 tahun lalu
CNAME 4d26137e2a Create CNAME 7 tahun lalu
LANGS.md d5a06aec83 Second try at configuring i18n for docsify and gitbook (#4531) 6 tahun lalu
README.md 73ddb764cc Fix readme and contributing hyperlinks 7 tahun lalu
_summary.md 330e2e6af5 Address comments in #4832. Move info.json reference to its own file. 6 tahun lalu
arm_debugging.md ac7b2d92bf ARM SWD guide 6 tahun lalu
becoming_a_qmk_collaborator.md 1acaf2b2c2 Tweak the wording in "Becoming a QMK Collaborator" 6 tahun lalu
compatible_microcontrollers.md 7b0356d1d4 Convert all headings to Title Case 7 tahun lalu
config_options.md 4d9b11af14 Fix Command feature: use get_mods() instead of keyboard_report->mods (#4955) 6 tahun lalu
contributing.md 7458ac9489 Update Contrib doc (#4068) 6 tahun lalu
custom_quantum_functions.md cc5c6b449a Add kb and user level keyboard initialization functions (#3113) 6 tahun lalu
documentation_best_practices.md 303f425c6b Fix up info boxes. 7 tahun lalu
documentation_templates.md 8454fa5e9f Update Document Templates to reflect newer wording and URLs (#4006) 6 tahun lalu
eclipse.md 8e99fbc884 Fixed typo of 'confid.h' to 'config.h' (#2448) 7 tahun lalu
faq.md e6c638bed1 Overhaul the Getting Started section and add a FAQ section 7 tahun lalu
faq_build.md 4397b17ca0 faq_build.md: Add section about serial devices on Linux 6 tahun lalu
faq_debug.md bb53635f33 Trim trailing whitespace 7 tahun lalu
faq_general.md 7b0356d1d4 Convert all headings to Title Case 7 tahun lalu
faq_keymap.md 75a51659ab Add tap_random_base64 and software timer info to Useful Functions doc (#4360) 6 tahun lalu
feature_advanced_keycodes.md c789577675 Adds a period to the docs. 6 tahun lalu
feature_audio.md 9739d6ba0a Docs: Clarify audio keycodes (#4620) 6 tahun lalu
feature_auto_shift.md 303f425c6b Fix up info boxes. 7 tahun lalu
feature_backlight.md df251d7a13 Backlight - New option : BACKLIGHT_CAPS_LOCK (#4769) 6 tahun lalu
feature_bluetooth.md 914d42acd0 Update Bluetooth docs (#4062) 6 tahun lalu
feature_bootmagic.md 3a513fc3a3 [Docs] Bootmagic Lite Caveat (#5069) 6 tahun lalu
feature_combo.md e251850cd8 added missing ; on example (#5089) 6 tahun lalu
feature_command.md 4d9b11af14 Fix Command feature: use get_mods() instead of keyboard_report->mods (#4955) 6 tahun lalu
feature_debounce_type.md 7d8c629939 Stricter, leaner DEBOUNCE_TYPE section in common_features.mk. Cleanup debounce_type.mk 6 tahun lalu
feature_dynamic_macros.md 6caea0acfb Docs: Adjust dynamic macro docs to include more than the planck (#3509) 7 tahun lalu
feature_encoders.md 1e1b55fbdf Improve Encoder documentation (#5130) 6 tahun lalu
feature_grave_esc.md 2bc34b09cd Docs: Format Grave Escape documentation (#3536) 7 tahun lalu
feature_hd44780.md bbea9dadbc Integrating Peter Fleury's HD44780 LCD library (#3209) 7 tahun lalu
feature_key_lock.md c11a26ba54 Docs: Format Key Lock documentation (#3538) 7 tahun lalu
feature_layouts.md 40e67a3074 Add a mechanism for force building a particular community layout (#5027) 6 tahun lalu
feature_leader_key.md afd5cda4a0 Fix up process_leader to be a bit more optimized (#4662) 6 tahun lalu
feature_led_matrix.md 24df54b807 Add documentation for led matrix 6 tahun lalu
feature_macros.md 02d44beb44 Fix up tap_code functionality (#4609) 6 tahun lalu
feature_mouse_keys.md 7f7f763598 Fixed dead links (#2451) 7 tahun lalu
feature_pointing_device.md af37bb2f78 Fix some of the more obvious typos 7 tahun lalu
feature_ps2_mouse.md 58b9b22670 Circuitry sample for PS/2 Mouse (#3959) 6 tahun lalu
feature_rgb_matrix.md 24df54b807 Add documentation for led matrix 6 tahun lalu
feature_rgblight.md 9e6ee47779 Added noeeprom versions of set hue, sat, val, and step 6 tahun lalu
feature_space_cadet_shift.md 5c7a31eae2 Improvements to Space Cadet Shift (#3856) 6 tahun lalu
feature_space_cadet_shift_enter.md 03ad6927cb Docs: Format Space Cadet documentation (#3540) 7 tahun lalu
feature_stenography.md c0baf2a964 Improve state/chord handling and clean up namespace 7 tahun lalu
feature_swap_hands.md fd085837e1 fix swap_hands keycodes in documentation (#3588) 6 tahun lalu
feature_tap_dance.md 641bbeb41a Remove userspace info from Quad-Function Tap Dance example (#4631) 6 tahun lalu
feature_terminal.md 5112af887a Added command history to terminal with other bug fixes, added new song to song_list.h (#2855) 7 tahun lalu
feature_thermal_printer.md 4c675a83ba Format keycode tables 7 tahun lalu
feature_unicode.md cd9262d7b2 Improve consistency in UNICODEMAP code and docs, update docs/understanding_qmk (#4774) 6 tahun lalu
feature_userspace.md f1b2d46eaf Spell-check update for Userspace documentation 6 tahun lalu
features.md 52f1206712 Fix Encoder documentation (#4861) 6 tahun lalu
flashing.md 292a87ad04 Instructions on how to flash via STM32 bootloader (#4316) 6 tahun lalu
fuse.txt ca01d94005 convert docs to lowercase and underscores 8 tahun lalu
getting_started_build_tools.md cd369b7107 docker_build.sh: Run container in interactive mode (#5088) 6 tahun lalu
getting_started_getting_help.md 48913153c3 Replace gitter links with Discord. (#3368) 7 tahun lalu
getting_started_github.md 76aa2baf3e Fix doc typo 6 tahun lalu
getting_started_introduction.md c5c112ae29 Update config.h boilerplate to use `#pragma once` 7 tahun lalu
getting_started_make_guide.md 28929ad017 Simplify split_common Code significantly (#4772) 6 tahun lalu
getting_started_vagrant.md af37bb2f78 Fix some of the more obvious typos 7 tahun lalu
hand_wire.md bb53635f33 Trim trailing whitespace 7 tahun lalu
hardware.md af37bb2f78 Fix some of the more obvious typos 7 tahun lalu
hardware_avr.md ab3fbfdb3b Update hardware config warnings to be more accurate 6 tahun lalu
hardware_drivers.md fdd0f91527 ISSI31FL3733 driver (#3679) 6 tahun lalu
hardware_keyboard_guidelines.md aeee735f35 Clarify LAYOUT vs LAYOUT_all 6 tahun lalu
how_keyboards_work.md d08f9cb6e4 Fix grammar, typos, and the link to HID specification 6 tahun lalu
i2c_driver.md 24df54b807 Add documentation for led matrix 6 tahun lalu
index.html 3cf179be61 Adds Proton C Conversion (#4661) 6 tahun lalu
internals_defines.md ae7284edb8 rename api docs to internals 7 tahun lalu
internals_gpio_control.md 3c26f07f5a Grammatical fixes for GPIO Control doc (#4869) 6 tahun lalu
internals_input_callback_reg.md ae7284edb8 rename api docs to internals 7 tahun lalu
internals_midi_device.md ae7284edb8 rename api docs to internals 7 tahun lalu
internals_midi_device_setup_process.md ae7284edb8 rename api docs to internals 7 tahun lalu
internals_midi_util.md ae7284edb8 rename api docs to internals 7 tahun lalu
internals_send_functions.md ae7284edb8 rename api docs to internals 7 tahun lalu
internals_sysex_tools.md ae7284edb8 rename api docs to internals 7 tahun lalu
isp_flashing_guide.md 5dcb1114d7 Fix a typo in link to the Pro Micro ISP firmware 6 tahun lalu
keycodes.md 79b58937f4 Add C(), A() and G() to match already existing S() (#4673) 6 tahun lalu
keycodes_basic.md ba05f9667b Add new brightness aliases to keycodes_basic.md 6 tahun lalu
keycodes_us_ansi_shifted.md 9374c0c9db Add caveats for shifted characters (#4192) 6 tahun lalu
keymap.md 334e2629df Remove redefinition of `_______` in documentation example (#3924) 6 tahun lalu
newbs.md efe360464d Contribute the MechMerlin QMK Configurator docs (#4986) 6 tahun lalu
newbs_best_practices.md 480651cf9d Docs: Adding QMK Git Conventions doc; formatting cleanup on Learning Resources doc (#3902) 6 tahun lalu
newbs_building_firmware.md a5b10e5da2 Fix syntax for windows 6 tahun lalu
newbs_building_firmware_configurator.md efe360464d Contribute the MechMerlin QMK Configurator docs (#4986) 6 tahun lalu
newbs_flashing.md 303f425c6b Fix up info boxes. 7 tahun lalu
newbs_getting_started.md efe360464d Contribute the MechMerlin QMK Configurator docs (#4986) 6 tahun lalu
newbs_learn_more_resources.md 480651cf9d Docs: Adding QMK Git Conventions doc; formatting cleanup on Learning Resources doc (#3902) 6 tahun lalu
newbs_testing_debugging.md 90f9fb4eee Fixed docs/newbs_testing_debugging.md and tmk_core/common/print.h 6 tahun lalu
porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md af37bb2f78 Fix some of the more obvious typos 7 tahun lalu
power.txt bb53635f33 Trim trailing whitespace 7 tahun lalu
proton_c_conversion.md 3cf179be61 Adds Proton C Conversion (#4661) 6 tahun lalu
qmk.css ccc87421e7 Some more tweaks to make everything look nice 7 tahun lalu
quantum_keycodes.md 6e44f94f21 Add EEPROM_RESET keycode to core code (#4234) 6 tahun lalu
redirects.json 03ad6927cb Docs: Format Space Cadet documentation (#3540) 7 tahun lalu
ref_functions.md 75a51659ab Add tap_random_base64 and software timer info to Useful Functions doc (#4360) 6 tahun lalu
reference_configurator_support.md d8f090e559 Docs: Supporting a keyboard in the QMK Configurator (#4396) 6 tahun lalu
reference_glossary.md dad79cafcd Fix more broken links to the HID spec 6 tahun lalu
reference_info_json.md bcb1815420 Add label to the info.json reference 6 tahun lalu
sidebar.css 7d49a17781 override hamburger placement 7 tahun lalu
support.md 2ad2b73d68 Add support for PR and Issue templates to QMK_firmware GitHub (#4494) 6 tahun lalu
sw.js 303f425c6b Fix up info boxes. 7 tahun lalu
understanding_qmk.md cd9262d7b2 Improve consistency in UNICODEMAP code and docs, update docs/understanding_qmk (#4774) 6 tahun lalu
unit_testing.md bb53635f33 Trim trailing whitespace 7 tahun lalu
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores 8 tahun lalu

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.