qmk_firmware/docs
Max Riveiro f1451b4b04 Fix HSV Color Wheel image on RGB Light page (#1773)
Signed-off-by: Max Riveiro <kavu13@gmail.com>
2017-09-29 16:19:15 -07:00
..
gitbook/images RGB improvements (#1684) 2017-09-06 14:49:19 -07:00
README.md Fix these links, as they appear to be broken (#1595) 2017-08-18 00:18:04 -07:00
_summary.md Updates send_string functionality, adds terminal feature (#1657) 2017-09-12 00:43:10 -04:00
adding_a_keyboard_to_qmk.md Create adding_a_keyboard_to_qmk.md 2017-06-22 13:22:21 -04:00
adding_features_to_qmk.md Doc updates from going through every file 2017-08-16 15:47:20 -04:00
becoming_a_qmk_collaborator.md convert docs to lowercase and underscores 2017-06-10 14:58:24 -04:00
compatible_microcontrollers.md convert docs to lowercase and underscores 2017-06-10 14:58:24 -04:00
config_options.md adds config options md 2017-06-28 21:20:23 -04:00
custom_quantum_functions.md Fix minor formatting issue. 2017-07-23 15:10:27 -04:00
documentation_best_practices.md Doc updates from going through every file 2017-08-16 15:47:20 -04:00
dynamic_macros.md convert docs to lowercase and underscores 2017-06-10 14:58:24 -04:00
eclipse.md Update a bunch of docs 2017-07-03 01:30:36 -07:00
faq.md Overhaul the Getting Started section and add a FAQ section 2017-08-16 15:47:20 -04:00
faq_build.md Fix these links, as they appear to be broken (#1595) 2017-08-18 00:18:04 -07:00
faq_debug.md Doc updates from going through every file 2017-08-16 15:47:20 -04:00
faq_general.md Doc updates from going through every file 2017-08-16 15:47:20 -04:00
faq_keymap.md Doc updates from going through every file 2017-08-16 15:47:20 -04:00
feature_audio.md Doc updates from going through every file 2017-08-16 15:47:20 -04:00
feature_auto_shift.md Fixed a few typos and spelling errors in auto shift feature document 2017-09-18 17:08:18 -04:00
feature_backlight.md break up keymaps and quantum keycodes into files by feature 2017-08-16 15:47:20 -04:00
feature_bluetooth.md Doc updates from going through every file 2017-08-16 15:47:20 -04:00
feature_bootmagic.md break up keymaps and quantum keycodes into files by feature 2017-08-16 15:47:20 -04:00
feature_common_shortcuts.md Fixed typo of "multually" to "mutually" 2017-09-25 13:08:06 -04:00
feature_layouts.md Creates a layouts/ folder for keymaps shared between keyboards (#1609) 2017-08-23 22:29:07 -04:00
feature_leader_key.md Doc updates from going through every file 2017-08-16 15:47:20 -04:00
feature_ps2_mouse.md Doc updates from going through every file 2017-08-16 15:47:20 -04:00
feature_rgblight.md Fix HSV Color Wheel image on RGB Light page (#1773) 2017-09-29 16:19:15 -07:00
feature_terminal.md Updates send_string functionality, adds terminal feature (#1657) 2017-09-12 00:43:10 -04:00
feature_thermal_printer.md break up keymaps and quantum keycodes into files by feature 2017-08-16 15:47:20 -04:00
features.md Doc updates from going through every file 2017-08-16 15:47:20 -04:00
fuse.txt convert docs to lowercase and underscores 2017-06-10 14:58:24 -04:00
getting_started_build_tools.md Add shell.nix for NixOS users 2017-09-25 13:14:20 -04:00
getting_started_github.md Overhaul the Getting Started section and add a FAQ section 2017-08-16 15:47:20 -04:00
getting_started_instroduction.md Overhaul the Getting Started section and add a FAQ section 2017-08-16 15:47:20 -04:00
getting_started_make_guide.md Remove all Makefiles from the keyboards directory. (#1660) 2017-09-08 13:47:50 -04:00
getting_started_vagrant.md Overhaul the Getting Started section and add a FAQ section 2017-08-16 15:47:20 -04:00
glossary.md Update links in the glossary 2017-08-16 15:47:20 -04:00
hand_wire.md Remove all Makefiles from the keyboards directory. (#1660) 2017-09-08 13:47:50 -04:00
how_keyboards_work.md Add link to keycodes doc in how_keyboards_work 2017-08-18 12:49:55 -04:00
isp_flashing_guide.md update docs for isp 2017-06-23 23:09:14 -04:00
key_lock.md Added support for locking One Shot modifiers. 2017-08-08 10:02:53 -04:00
keycode.txt Docfix (#1377) 2017-06-08 20:05:55 -07:00
keycodes.md updated keycodes media descriptions 2017-09-25 13:07:46 -04:00
keycodes_basic.md platform descriptions to match master keycodes.md documentation 2017-09-25 13:07:46 -04:00
keycodes_us_ansi_shifted.md break up keymaps and quantum keycodes into files by feature 2017-08-16 15:47:20 -04:00
keymap.md Doc updates from going through every file 2017-08-16 15:47:20 -04:00
macros.md Updates send_string functionality, adds terminal feature (#1657) 2017-09-12 00:43:10 -04:00
mouse_keys.md Merge branch 'master' into docs 2017-07-06 18:43:22 -07:00
porting_your_keyboard_to_qmk.md Doc updates from going through every file 2017-08-16 15:47:20 -04:00
porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md convert docs to lowercase and underscores 2017-06-10 14:58:55 -04:00
power.txt convert docs to lowercase and underscores 2017-06-10 14:58:55 -04:00
quantum_keycodes.md Doc updates from going through every file 2017-08-16 15:47:20 -04:00
redirects.json validates json 2017-08-19 08:35:14 -04:00
space_cadet_shift.md convert docs to lowercase and underscores 2017-06-10 14:58:55 -04:00
stenography.md Add compile error if too many endpoints are defined for the ATmega32U4. 2017-08-20 11:51:57 -04:00
tap_dance.md Update a bunch of docs 2017-07-03 01:30:36 -07:00
understanding_qmk.md Added Auto Shift, tap key = normal, hold key = shifted state. 2017-09-18 17:08:18 -04:00
unicode.md add UC_OSX_RALT to make unicode use the Right Alt key on OSX 2017-08-30 11:38:03 -04:00
unit_testing.md convert docs to lowercase and underscores 2017-06-10 14:58:55 -04:00
usb_nkro.txt convert docs to lowercase and underscores 2017-06-10 14:58:55 -04:00

README.md

Quantum Mechanical Keyboard Firmware

What is QMK Firmware?

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