Home Esplora Aiuto
Registrati Accedi
HuiJun
/
qmk_firmware
1
0
Forka 0
File Problemi 0 Pull Requests 0 Wiki
Albero (Tree): planck-6.0
Rami (Branch) Tag
qmk_firmware
/
docs
Evan Travers f2fcffab0d Docs: Adjust prompt to be more recognizable (#3417) 7 anni fa
..
gitbook 4580d3a730 RGB improvements (#1684) 7 anni fa
.nojekyll 9e5676650e Use docsfy to replace gitbook 7 anni fa
CNAME 4d26137e2a Create CNAME 7 anni fa
README.md 73ddb764cc Fix readme and contributing hyperlinks 7 anni fa
_sidebar.md 9f2bb11412 Make sure new features (RGB Matrix) are actually listed 7 anni fa
_summary.md 8ffeaec3aa Overhaul to keycode related docs 7 anni fa
becoming_a_qmk_collaborator.md 7b0356d1d4 Convert all headings to Title Case 7 anni fa
compatible_microcontrollers.md 7b0356d1d4 Convert all headings to Title Case 7 anni fa
config_options.md 8ffeaec3aa Overhaul to keycode related docs 7 anni fa
contributing.md 48913153c3 Replace gitter links with Discord. (#3368) 7 anni fa
custom_quantum_functions.md 48913153c3 Replace gitter links with Discord. (#3368) 7 anni fa
documentation_best_practices.md 303f425c6b Fix up info boxes. 7 anni fa
documentation_templates.md 800ec55dfc Make arguments redo, subproject elimination (#1784) 7 anni fa
eclipse.md 8e99fbc884 Fixed typo of 'confid.h' to 'config.h' (#2448) 7 anni fa
faq.md e6c638bed1 Overhaul the Getting Started section and add a FAQ section 7 anni fa
faq_build.md 0d5a8b048a Instruct macos users to use avr-gcc@7 (#3337) 7 anni fa
faq_debug.md bb53635f33 Trim trailing whitespace 7 anni fa
faq_general.md 7b0356d1d4 Convert all headings to Title Case 7 anni fa
faq_keymap.md e87c39d302 More thoroughly document Bootmagic and Command (#2455) 7 anni fa
feature_advanced_keycodes.md 8ffeaec3aa Overhaul to keycode related docs 7 anni fa
feature_audio.md 8ffeaec3aa Overhaul to keycode related docs 7 anni fa
feature_auto_shift.md 303f425c6b Fix up info boxes. 7 anni fa
feature_backlight.md 4764e77121 Clarify that we actually have max 16 total backlight levels 7 anni fa
feature_bluetooth.md 4c675a83ba Format keycode tables 7 anni fa
feature_bootmagic.md cdb967f22b Fix link to command page 7 anni fa
feature_command.md e87c39d302 More thoroughly document Bootmagic and Command (#2455) 7 anni fa
feature_dynamic_macros.md bb53635f33 Trim trailing whitespace 7 anni fa
feature_grave_esc.md 4c675a83ba Format keycode tables 7 anni fa
feature_hd44780.md bbea9dadbc Integrating Peter Fleury's HD44780 LCD library (#3209) 7 anni fa
feature_key_lock.md 7b0356d1d4 Convert all headings to Title Case 7 anni fa
feature_layouts.md 2018df1a61 Clarify the format for layout names 7 anni fa
feature_leader_key.md 3b1ddd12a5 Refresh & improve leader documentation page (#2990) 7 anni fa
feature_macros.md 303f425c6b Fix up info boxes. 7 anni fa
feature_mouse_keys.md 7f7f763598 Fixed dead links (#2451) 7 anni fa
feature_pointing_device.md af37bb2f78 Fix some of the more obvious typos 7 anni fa
feature_ps2_mouse.md bb53635f33 Trim trailing whitespace 7 anni fa
feature_rgb_matrix.md a7df902734 Addition of hard brigtness limit for RGB_Matrix (#3299) 7 anni fa
feature_rgblight.md 5229734647 Add rgblight mode 35 (R,G,B test mode) (#3114) 7 anni fa
feature_space_cadet.md af37bb2f78 Fix some of the more obvious typos 7 anni fa
feature_space_shift_cadet.md 8a1e656099 new planck keymap, new feature - hybrid shift/enter action key (great for small keyboards!) (#2100) 7 anni fa
feature_stenography.md c0baf2a964 Improve state/chord handling and clean up namespace 7 anni fa
feature_swap_hands.md 23ac2a02ef Add keycodes for swap-hands feature. 7 anni fa
feature_tap_dance.md a87b36d791 fix a few simple typos (#3068) 7 anni fa
feature_terminal.md 5112af887a Added command history to terminal with other bug fixes, added new song to song_list.h (#2855) 7 anni fa
feature_thermal_printer.md 4c675a83ba Format keycode tables 7 anni fa
feature_unicode.md af37bb2f78 Fix some of the more obvious typos 7 anni fa
feature_userspace.md 5ca9aecfb4 Talljoe's layout with common keymap. (#2764) 7 anni fa
features.md bbea9dadbc Integrating Peter Fleury's HD44780 LCD library (#3209) 7 anni fa
flashing.md a7fca47686 Link to Atmel's flip is broken. (#2752) 7 anni fa
fuse.txt ca01d94005 convert docs to lowercase and underscores 8 anni fa
getting_started_build_tools.md 0d5a8b048a Instruct macos users to use avr-gcc@7 (#3337) 7 anni fa
getting_started_getting_help.md 48913153c3 Replace gitter links with Discord. (#3368) 7 anni fa
getting_started_github.md f2fcffab0d Docs: Adjust prompt to be more recognizable (#3417) 7 anni fa
getting_started_introduction.md c5c112ae29 Update config.h boilerplate to use `#pragma once` 7 anni fa
getting_started_make_guide.md 00596d55e3 Added propper support for Lets split vitamins (#2559) 7 anni fa
getting_started_vagrant.md af37bb2f78 Fix some of the more obvious typos 7 anni fa
hand_wire.md bb53635f33 Trim trailing whitespace 7 anni fa
hardware.md af37bb2f78 Fix some of the more obvious typos 7 anni fa
hardware_avr.md 303f425c6b Fix up info boxes. 7 anni fa
hardware_drivers.md 7b0356d1d4 Convert all headings to Title Case 7 anni fa
hardware_keyboard_guidelines.md 9fb1e5d171 Remove bootloader key as it is no longer used (#3093) 7 anni fa
how_keyboards_work.md 7b0356d1d4 Convert all headings to Title Case 7 anni fa
index.html 7d49a17781 override hamburger placement 7 anni fa
internals_defines.md ae7284edb8 rename api docs to internals 7 anni fa
internals_input_callback_reg.md ae7284edb8 rename api docs to internals 7 anni fa
internals_midi_device.md ae7284edb8 rename api docs to internals 7 anni fa
internals_midi_device_setup_process.md ae7284edb8 rename api docs to internals 7 anni fa
internals_midi_util.md ae7284edb8 rename api docs to internals 7 anni fa
internals_send_functions.md ae7284edb8 rename api docs to internals 7 anni fa
internals_sysex_tools.md ae7284edb8 rename api docs to internals 7 anni fa
isp_flashing_guide.md bb53635f33 Trim trailing whitespace 7 anni fa
keycode.txt bb53635f33 Trim trailing whitespace 7 anni fa
keycodes.md 8ffeaec3aa Overhaul to keycode related docs 7 anni fa
keycodes_basic.md 6590f3c811 Clean up SEND_STRING keycodes and add media keys (#3214) 7 anni fa
keycodes_us_ansi_shifted.md bb53635f33 Trim trailing whitespace 7 anni fa
keymap.md 07b90db897 Fixes and updates to docs (#2611) 7 anni fa
newbs.md c7b8e45ba1 Docs: add resources for git (#3390) 7 anni fa
newbs_building_firmware.md 303f425c6b Fix up info boxes. 7 anni fa
newbs_flashing.md 303f425c6b Fix up info boxes. 7 anni fa
newbs_getting_started.md 06b3637266 added some helpful notes to the documentation (#2981) 7 anni fa
newbs_learn_more_resources.md c7b8e45ba1 Docs: add resources for git (#3390) 7 anni fa
newbs_testing_debugging.md 08e48eb6f5 Add a newbie guide for people completely new to QMK (#2480) 7 anni fa
porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md af37bb2f78 Fix some of the more obvious typos 7 anni fa
power.txt bb53635f33 Trim trailing whitespace 7 anni fa
qmk.css ccc87421e7 Some more tweaks to make everything look nice 7 anni fa
quantum_keycodes.md bb53635f33 Trim trailing whitespace 7 anni fa
redirects.json 566399794a Disable the glossary linking to fix #2498 (#2499) 7 anni fa
reference_glossary.md 566399794a Disable the glossary linking to fix #2498 (#2499) 7 anni fa
sidebar.css 7d49a17781 override hamburger placement 7 anni fa
sw.js 303f425c6b Fix up info boxes. 7 anni fa
understanding_qmk.md 7f7f763598 Fixed dead links (#2451) 7 anni fa
unit_testing.md bb53635f33 Trim trailing whitespace 7 anni fa
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores 8 anni fa

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.