Эхлэл Бүгдийг харах Тусламж
Бүртгүүлэх Нэвтрэх
HuiJun
/
qmk_firmware
1
0
Салаа 0
Файлууд Асуудлууд 0 Хуулах хүсэлтүүд 0 Мэдлэгийн сан
Мод: planck-6.1
Салаанууд Тагууд
qmk_firmware
/
docs
Frank Tackitt 94f58322ac Configurable Rainbow Swirl range (#4376) 6 жил өмнө
..
gitbook 4580d3a730 RGB improvements (#1684) 7 жил өмнө
.nojekyll 9e5676650e Use docsfy to replace gitbook 7 жил өмнө
CNAME 4d26137e2a Create CNAME 7 жил өмнө
README.md 73ddb764cc Fix readme and contributing hyperlinks 7 жил өмнө
_sidebar.md 85688e5b52 add support for encoders to core 6 жил өмнө
_summary.md 85688e5b52 add support for encoders to core 6 жил өмнө
arm_debugging.md ac7b2d92bf ARM SWD guide 6 жил өмнө
becoming_a_qmk_collaborator.md 1acaf2b2c2 Tweak the wording in "Becoming a QMK Collaborator" 6 жил өмнө
compatible_microcontrollers.md 7b0356d1d4 Convert all headings to Title Case 7 жил өмнө
config_options.md 6729265625 Clarify the Mod Tap defines in documentation (#4352) 6 жил өмнө
contributing.md 7458ac9489 Update Contrib doc (#4068) 6 жил өмнө
custom_quantum_functions.md d81d216d72 Fix Typo in Custom Quantum functions document (led_state) (#4129) 6 жил өмнө
documentation_best_practices.md 303f425c6b Fix up info boxes. 7 жил өмнө
documentation_templates.md 8454fa5e9f Update Document Templates to reflect newer wording and URLs (#4006) 6 жил өмнө
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 7 жил өмнө
faq_build.md 91bfbb6256 Updates docs - planck 6 and macos instructions (#4201) 6 жил өмнө
faq_debug.md bb53635f33 Trim trailing whitespace 7 жил өмнө
faq_general.md 7b0356d1d4 Convert all headings to Title Case 7 жил өмнө
faq_keymap.md bfc9aa66f9 Docs: Update image in FAQ/Keymap: KC_EQLS -> KC_EQL (#3660) 6 жил өмнө
feature_advanced_keycodes.md 6729265625 Clarify the Mod Tap defines in documentation (#4352) 6 жил өмнө
feature_audio.md a0309db983 Add On/Off keycodes 6 жил өмнө
feature_auto_shift.md 303f425c6b Fix up info boxes. 7 жил өмнө
feature_backlight.md fa1ac4d724 Fix incorrect doctoring in feature.backlight.md (#4244) 6 жил өмнө
feature_bluetooth.md 914d42acd0 Update Bluetooth docs (#4062) 6 жил өмнө
feature_bootmagic.md 7373d5b394 Update feature_bootmagic.md (#4290) 6 жил өмнө
feature_combo.md 26a201e687 fix example to reflect caveat 6 жил өмнө
feature_command.md 25d757284c Docs: Fix Command docs escaping (#3523) 6 жил өмнө
feature_dynamic_macros.md 6caea0acfb Docs: Adjust dynamic macro docs to include more than the planck (#3509) 6 жил өмнө
feature_encoders.md 24b3556e84 add better example 6 жил өмнө
feature_grave_esc.md 2bc34b09cd Docs: Format Grave Escape documentation (#3536) 6 жил өмнө
feature_hd44780.md bbea9dadbc Integrating Peter Fleury's HD44780 LCD library (#3209) 6 жил өмнө
feature_key_lock.md c11a26ba54 Docs: Format Key Lock documentation (#3538) 6 жил өмнө
feature_layouts.md 08c682c193 Docs: Add docs for the `LAYOUT_*` macro to layouts (#3772) 6 жил өмнө
feature_leader_key.md 244e1c5a57 Fix LEADER_KEY docs. 6 жил өмнө
feature_macros.md 26f4e7031a Add tap_code function (#3784) 6 жил өмнө
feature_mouse_keys.md 7f7f763598 Fixed dead links (#2451) 7 жил өмнө
feature_pointing_device.md af37bb2f78 Fix some of the more obvious typos 7 жил өмнө
feature_ps2_mouse.md 58b9b22670 Circuitry sample for PS/2 Mouse (#3959) 6 жил өмнө
feature_rgb_matrix.md da6c58175a Make digital rain RGB matrix effect #define configurable. 6 жил өмнө
feature_rgblight.md 94f58322ac Configurable Rainbow Swirl range (#4376) 6 жил өмнө
feature_space_cadet_shift.md 03ad6927cb Docs: Format Space Cadet documentation (#3540) 6 жил өмнө
feature_space_cadet_shift_enter.md 03ad6927cb Docs: Format Space Cadet documentation (#3540) 6 жил өмнө
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) 6 жил өмнө
feature_tap_dance.md d210ac7a3e Add caveat for basic keycodes in Tap Dance docs 6 жил өмнө
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 7 жил өмнө
feature_unicode.md 5a127293e7 Fix formatting in Unicode text 6 жил өмнө
feature_userspace.md f1b2d46eaf Spell-check update for Userspace documentation 6 жил өмнө
features.md 4a033641df Update Features page to reflect all of the features linked in the sidebar/summary 6 жил өмнө
flashing.md 292a87ad04 Instructions on how to flash via STM32 bootloader (#4316) 6 жил өмнө
fuse.txt ca01d94005 convert docs to lowercase and underscores 8 жил өмнө
getting_started_build_tools.md 552b1cccec Update the installation script PR (#4167) 6 жил өмнө
getting_started_getting_help.md 48913153c3 Replace gitter links with Discord. (#3368) 7 жил өмнө
getting_started_github.md 76aa2baf3e Fix doc typo 6 жил өмнө
getting_started_introduction.md c5c112ae29 Update config.h boilerplate to use `#pragma once` 6 жил өмнө
getting_started_make_guide.md 0fab3bbde3 Lets split eh (#3120) 6 жил өмнө
getting_started_vagrant.md af37bb2f78 Fix some of the more obvious typos 7 жил өмнө
hand_wire.md bb53635f33 Trim trailing whitespace 7 жил өмнө
hardware.md af37bb2f78 Fix some of the more obvious typos 7 жил өмнө
hardware_avr.md ab3fbfdb3b Update hardware config warnings to be more accurate 6 жил өмнө
hardware_drivers.md fdd0f91527 ISSI31FL3733 driver (#3679) 6 жил өмнө
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 6 жил өмнө
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) 6 жил өмнө
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) 6 жил өмнө
keycode.txt bb53635f33 Trim trailing whitespace 7 жил өмнө
keycodes.md 4636f0f623 Remove ALTG(kc) as it's misleading and is not actually AltGr (#4338) 6 жил өмнө
keycodes_basic.md dad79cafcd Fix more broken links to the HID spec 6 жил өмнө
keycodes_us_ansi_shifted.md 9374c0c9db Add caveats for shifted characters (#4192) 6 жил өмнө
keymap.md 334e2629df Remove redefinition of `_______` in documentation example (#3924) 6 жил өмнө
newbs.md 480651cf9d Docs: Adding QMK Git Conventions doc; formatting cleanup on Learning Resources doc (#3902) 6 жил өмнө
newbs_best_practices.md 480651cf9d Docs: Adding QMK Git Conventions doc; formatting cleanup on Learning Resources doc (#3902) 6 жил өмнө
newbs_building_firmware.md a5b10e5da2 Fix syntax for windows 6 жил өмнө
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) 6 жил өмнө
newbs_learn_more_resources.md 480651cf9d Docs: Adding QMK Git Conventions doc; formatting cleanup on Learning Resources doc (#3902) 6 жил өмнө
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 7 жил өмнө
power.txt bb53635f33 Trim trailing whitespace 7 жил өмнө
qmk.css ccc87421e7 Some more tweaks to make everything look nice 7 жил өмнө
quantum_keycodes.md 6e44f94f21 Add EEPROM_RESET keycode to core code (#4234) 6 жил өмнө
redirects.json 03ad6927cb Docs: Format Space Cadet documentation (#3540) 6 жил өмнө
ref_functions.md 7e1b57add4 Some cleanup of the Useful Functions docs (#4064) 6 жил өмнө
reference_glossary.md dad79cafcd Fix more broken links to the HID spec 6 жил өмнө
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) 6 жил өмнө
unit_testing.md bb53635f33 Trim trailing whitespace 7 жил өмнө
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.