qmk_firmware/docs
Joe Wasson 5ca9aecfb4 Talljoe's layout with common keymap. (#2764)
* Add userspace to talljoe layout.

* Move more authority to userspace and create Bananasplit layout.

* Move more things into userspace.

* Common Core example

* More work on common layout.

* Num layer.

* talljoe-ansi layout

* Updates for Zeal60

* Add Zeal60 to 60_ansi_split_bs_rshift

* Swap Escape and Grave

* Num-layer tweaks

* More tweaks.

* Add 1up60rgb to world of layouts.

* Rename ansi_split_bs_rshift layout to hhkb.

* Control RGB Backlight.

* change capslock led

* Remove obsolete line from rules.mk.

* Add user-friendly userspace override.

* Fix enter for 1uprgb60

* Revert "Rename ansi_split_bs_rshift layout to hhkb."

This reverts commit 53133719db25c7cb6a199108bbf5d980481a45f4.
2018-04-21 10:48:30 -07:00
..
gitbook/images
README.md
_summary.md rename api docs to internals 2018-03-26 11:43:37 -07:00
becoming_a_qmk_collaborator.md
compatible_microcontrollers.md
config_options.md Correct documentation for `PREVENT_STUCK_MODIFIERS` 2018-04-19 01:52:34 -04:00
contributing.md
custom_quantum_functions.md
documentation_best_practices.md
documentation_templates.md
eclipse.md
faq.md
faq_build.md Fixes and updates to docs (#2611) 2018-03-25 16:44:17 -07:00
faq_debug.md
faq_general.md
faq_keymap.md
feature_advanced_keycodes.md Rework layer function docs (#2656) 2018-04-21 09:21:46 -07:00
feature_audio.md Add Faux Clicking as subset of Audio feature (#2748) 2018-04-19 01:47:04 -04:00
feature_auto_shift.md
feature_backlight.md
feature_bluetooth.md
feature_bootmagic.md Fix link to command page 2018-04-15 11:53:31 -04:00
feature_command.md
feature_dynamic_macros.md
feature_grave_esc.md
feature_key_lock.md
feature_layouts.md
feature_leader_key.md
feature_macros.md
feature_mouse_keys.md
feature_pointing_device.md
feature_ps2_mouse.md
feature_rgblight.md Add rgblist to docs 2018-03-28 16:55:58 -04:00
feature_space_cadet.md
feature_space_shift_cadet.md
feature_stenography.md Improve state/chord handling and clean up namespace 2018-04-07 17:12:44 -04:00
feature_swap_hands.md
feature_tap_dance.md Update feature_tap_dance.md (#2643) 2018-04-21 00:43:36 -07:00
feature_terminal.md
feature_thermal_printer.md
feature_unicode.md
feature_userspace.md Talljoe's layout with common keymap. (#2764) 2018-04-21 10:48:30 -07:00
features.md
flashing.md Link to Atmel's flip is broken. (#2752) 2018-04-18 22:21:36 -04:00
fuse.txt
getting_started_build_tools.md
getting_started_getting_help.md
getting_started_github.md
getting_started_introduction.md
getting_started_make_guide.md
getting_started_vagrant.md
hand_wire.md
hardware.md
hardware_avr.md
hardware_drivers.md
hardware_keyboard_guidelines.md Remove obsolete info.json entries (#2712) 2018-04-07 17:37:31 -07:00
how_keyboards_work.md
internals_defines.md rename api docs to internals 2018-03-26 11:43:37 -07:00
internals_input_callback_reg.md rename api docs to internals 2018-03-26 11:43:37 -07:00
internals_midi_device.md rename api docs to internals 2018-03-26 11:43:37 -07:00
internals_midi_device_setup_process.md rename api docs to internals 2018-03-26 11:43:37 -07:00
internals_midi_util.md rename api docs to internals 2018-03-26 11:43:37 -07:00
internals_send_functions.md rename api docs to internals 2018-03-26 11:43:37 -07:00
internals_sysex_tools.md rename api docs to internals 2018-03-26 11:43:37 -07:00
isp_flashing_guide.md
keycode.txt
keycodes.md
keycodes_basic.md
keycodes_us_ansi_shifted.md
keymap.md Fixes and updates to docs (#2611) 2018-03-25 16:44:17 -07:00
newbs.md
newbs_building_firmware.md
newbs_flashing.md Expand Newb Guide flashing document (#2588) 2018-03-26 13:34:18 -04:00
newbs_getting_started.md
newbs_testing_debugging.md
porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md
power.txt
quantum_keycodes.md
redirects.json
reference_glossary.md
understanding_qmk.md
unit_testing.md
usb_nkro.txt

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 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.