Ana Sayfa Keşfet Yardım
Giriş Yap
Tankernn
/
qmk_firmware
1
0
Çatalla 0
Dosyalar Sorunlar 0 Değişiklik İstekleri 0 Wiki
Ağaç: 00596d55e3
Dallar Biçim İmleri
qmk_firmware
/
docs
Mikkel Jeppesen 00596d55e3 Added propper support for Lets split vitamins (#2559) 7 yıl önce
..
gitbook 4580d3a730 RGB improvements (#1684) 8 yıl önce
.nojekyll 9e5676650e Use docsfy to replace gitbook 7 yıl önce
README.md 6ba73e0e04 update doc options 7 yıl önce
_sidebar.md ccc87421e7 Some more tweaks to make everything look nice 7 yıl önce
_summary.md ae7284edb8 rename api docs to internals 7 yıl önce
becoming_a_qmk_collaborator.md 7b0356d1d4 Convert all headings to Title Case 8 yıl önce
compatible_microcontrollers.md 7b0356d1d4 Convert all headings to Title Case 8 yıl önce
config_options.md 9b91789193 Add dilly/pletcher layout (#2880) 7 yıl önce
contributing.md bb53635f33 Trim trailing whitespace 8 yıl önce
custom_quantum_functions.md d965d72d4a Fix custom functions documation for layer_state_set* 7 yıl önce
documentation_best_practices.md 303f425c6b Fix up info boxes. 7 yıl önce
documentation_templates.md 800ec55dfc Make arguments redo, subproject elimination (#1784) 8 yıl önce
eclipse.md 8e99fbc884 Fixed typo of 'confid.h' to 'config.h' (#2448) 7 yıl önce
faq.md e6c638bed1 Overhaul the Getting Started section and add a FAQ section 8 yıl önce
faq_build.md 07b90db897 Fixes and updates to docs (#2611) 7 yıl önce
faq_debug.md bb53635f33 Trim trailing whitespace 8 yıl önce
faq_general.md 7b0356d1d4 Convert all headings to Title Case 8 yıl önce
faq_keymap.md e87c39d302 More thoroughly document Bootmagic and Command (#2455) 7 yıl önce
feature_advanced_keycodes.md 303f425c6b Fix up info boxes. 7 yıl önce
feature_audio.md 63d5c947d3 updated music mask 7 yıl önce
feature_auto_shift.md 303f425c6b Fix up info boxes. 7 yıl önce
feature_backlight.md 4764e77121 Clarify that we actually have max 16 total backlight levels 7 yıl önce
feature_bluetooth.md 4c675a83ba Format keycode tables 8 yıl önce
feature_bootmagic.md cdb967f22b Fix link to command page 7 yıl önce
feature_command.md e87c39d302 More thoroughly document Bootmagic and Command (#2455) 7 yıl önce
feature_dynamic_macros.md bb53635f33 Trim trailing whitespace 8 yıl önce
feature_grave_esc.md 4c675a83ba Format keycode tables 8 yıl önce
feature_key_lock.md 7b0356d1d4 Convert all headings to Title Case 8 yıl önce
feature_layouts.md 2018df1a61 Clarify the format for layout names 7 yıl önce
feature_leader_key.md 7b0356d1d4 Convert all headings to Title Case 8 yıl önce
feature_macros.md 303f425c6b Fix up info boxes. 7 yıl önce
feature_mouse_keys.md 7f7f763598 Fixed dead links (#2451) 7 yıl önce
feature_pointing_device.md af37bb2f78 Fix some of the more obvious typos 8 yıl önce
feature_ps2_mouse.md bb53635f33 Trim trailing whitespace 8 yıl önce
feature_rgb_matrix.md afacd42368 Add effect speed support for RGB Matrix *No EEPROM yet* (#2922) 7 yıl önce
feature_rgblight.md 331288233d Add rgblist to docs 7 yıl önce
feature_space_cadet.md af37bb2f78 Fix some of the more obvious typos 8 yıl önce
feature_space_shift_cadet.md 8a1e656099 new planck keymap, new feature - hybrid shift/enter action key (great for small keyboards!) (#2100) 8 yıl önce
feature_stenography.md c0baf2a964 Improve state/chord handling and clean up namespace 7 yıl önce
feature_swap_hands.md 23ac2a02ef Add keycodes for swap-hands feature. 7 yıl önce
feature_tap_dance.md e6be4484e9 Update to tap dance docs (#2895) 7 yıl önce
feature_terminal.md 5112af887a Added command history to terminal with other bug fixes, added new song to song_list.h (#2855) 7 yıl önce
feature_thermal_printer.md 4c675a83ba Format keycode tables 8 yıl önce
feature_unicode.md af37bb2f78 Fix some of the more obvious typos 8 yıl önce
feature_userspace.md 5ca9aecfb4 Talljoe's layout with common keymap. (#2764) 7 yıl önce
features.md af37bb2f78 Fix some of the more obvious typos 8 yıl önce
flashing.md a7fca47686 Link to Atmel's flip is broken. (#2752) 7 yıl önce
fuse.txt ca01d94005 convert docs to lowercase and underscores 8 yıl önce
getting_started_build_tools.md 767f7a8cf0 Fixed formatting for Fedora example 7 yıl önce
getting_started_getting_help.md 08e48eb6f5 Add a newbie guide for people completely new to QMK (#2480) 7 yıl önce
getting_started_github.md 303f425c6b Fix up info boxes. 7 yıl önce
getting_started_introduction.md 7b0356d1d4 Convert all headings to Title Case 8 yıl önce
getting_started_make_guide.md 00596d55e3 Added propper support for Lets split vitamins (#2559) 7 yıl önce
getting_started_vagrant.md af37bb2f78 Fix some of the more obvious typos 8 yıl önce
hand_wire.md bb53635f33 Trim trailing whitespace 8 yıl önce
hardware.md af37bb2f78 Fix some of the more obvious typos 8 yıl önce
hardware_avr.md 303f425c6b Fix up info boxes. 7 yıl önce
hardware_drivers.md 7b0356d1d4 Convert all headings to Title Case 8 yıl önce
hardware_keyboard_guidelines.md 3b525dcf9c Remove obsolete info.json entries (#2712) 7 yıl önce
how_keyboards_work.md 7b0356d1d4 Convert all headings to Title Case 8 yıl önce
index.html 6ba73e0e04 update doc options 7 yıl önce
internals_defines.md ae7284edb8 rename api docs to internals 7 yıl önce
internals_input_callback_reg.md ae7284edb8 rename api docs to internals 7 yıl önce
internals_midi_device.md ae7284edb8 rename api docs to internals 7 yıl önce
internals_midi_device_setup_process.md ae7284edb8 rename api docs to internals 7 yıl önce
internals_midi_util.md ae7284edb8 rename api docs to internals 7 yıl önce
internals_send_functions.md ae7284edb8 rename api docs to internals 7 yıl önce
internals_sysex_tools.md ae7284edb8 rename api docs to internals 7 yıl önce
isp_flashing_guide.md bb53635f33 Trim trailing whitespace 8 yıl önce
keycode.txt bb53635f33 Trim trailing whitespace 8 yıl önce
keycodes.md 7a5ce36f23 Add macro for momentarily switching to a layer while some mods are active (#2460) 7 yıl önce
keycodes_basic.md a2e12faa19 Add CMD and WIN aliases for KC_GUI, GUI(kc), GUI_T(kc), etc. 7 yıl önce
keycodes_us_ansi_shifted.md bb53635f33 Trim trailing whitespace 8 yıl önce
keymap.md 07b90db897 Fixes and updates to docs (#2611) 7 yıl önce
newbs.md 48e11240a6 Move the linux tutorials to an info box on newbs_getting_started 7 yıl önce
newbs_building_firmware.md 303f425c6b Fix up info boxes. 7 yıl önce
newbs_flashing.md 303f425c6b Fix up info boxes. 7 yıl önce
newbs_getting_started.md ccc87421e7 Some more tweaks to make everything look nice 7 yıl önce
newbs_testing_debugging.md 08e48eb6f5 Add a newbie guide for people completely new to QMK (#2480) 7 yıl önce
porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md af37bb2f78 Fix some of the more obvious typos 8 yıl önce
power.txt bb53635f33 Trim trailing whitespace 8 yıl önce
qmk.css ccc87421e7 Some more tweaks to make everything look nice 7 yıl önce
quantum_keycodes.md bb53635f33 Trim trailing whitespace 8 yıl önce
redirects.json 566399794a Disable the glossary linking to fix #2498 (#2499) 7 yıl önce
reference_glossary.md 566399794a Disable the glossary linking to fix #2498 (#2499) 7 yıl önce
sw.js 303f425c6b Fix up info boxes. 7 yıl önce
understanding_qmk.md 7f7f763598 Fixed dead links (#2451) 7 yıl önce
unit_testing.md bb53635f33 Trim trailing whitespace 8 yıl önce
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores 8 yıl önce

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.