qmk_firmware/docs
That-Canadian 0fab3bbde3 Lets split eh (#3120)
* Line ending stuff again

* Added Let's Split Eh? Files and updated #USE_IC2 checks to also include th EH revision (can only be used in I2C)

* Added personal keymap, updated some of the EH files

* Created new keyboard file for testing "lets_split_eh" will merge into lets_split once fully functional

* Added split code from lets_split, removed pro micro imports and LED code

THIS IS WORKING CODE, WITHOUT RGB AND BACKLIGHT

* Took back original Lets Slit files for the lets_split keyboard, working in the lets_split_eh folder for now

* Updated eh.c

* More rework of the I2C code, added global flags for split boards.

* Introduced RGB over I2C, having weird edge case issues at the moment though

* Fixed weird I2C edgecase with RGB, although still would like to track down route cause..

* Changed RGB keycodes (static ones) to activate on key-up instead of key-down to elimate weird ghosting issue over I2C

* Lots of changes, mainly externalized the Split keyboard code and added logic for only including when needed.

- Added makefile option "SPLIT_KEYBOARD" that when = yes will include the split keyboard files and custom matrix
- Split keyboard files placed into quantum/split_common/
- Added define option for config files "SPLIT_HAND_PIN" FOr using high/low pin to determine handedness, low = right hand, high = left hand
- Cleaned up split logic for RGB and Backlight so it is only exectuted / included when needed

* Updated documentation for the new makefile options and #defines specific to split keyboards

* Added a bit more info to docs, so people aren't confused

* Modifed Let's Split to use externalized code, also added left and right hand eeprom files to the split_common folder

* Removed some debugging from eh.c

* Small changes to keyboard configs. Also added a default keymap (just a copy of my that_canadian keymap).

* Added a README file to the Let's Split Eh?

* Changed it so RGB static updates are done on key-up ONLY for split boards rather than all boards. Also fixed leftover un-used variable in rgblight.c

* Updated default keymap and my keymap for Let's Split Eh? Updated the comments so it reflects RGB control, and removed audio functions.

* Fixed lets_split_eh not having a default version

* Removed "eh" references from lets_split folder for now

* Took lets_split folder from master to fix travis build errors, weird my local was overriding.

* Changed LAYOUT_ortho_4x12_kc -> LAYOUT_kc_ortho_4x12 to match bakingpy and others

* Removed rules.mk from my lets_split keymap, not needed

* Updated the config_options doc to better explain the usage of "#define SPLIT_HAND_PIN"
2018-07-16 22:25:02 -04:00
..
gitbook/images RGB improvements (#1684) 2017-09-06 14:49:19 -07:00
.nojekyll Use docsfy to replace gitbook 2018-05-07 22:46:26 -07:00
_sidebar.md Fix sidebard doc 2018-07-16 21:04:12 -04:00
_summary.md Fix sidebard doc 2018-07-16 21:04:12 -04:00
becoming_a_qmk_collaborator.md Convert all headings to Title Case 2017-12-09 10:46:11 -05:00
CNAME Create CNAME 2018-05-21 16:29:37 -04:00
compatible_microcontrollers.md Convert all headings to Title Case 2017-12-09 10:46:11 -05:00
config_options.md Lets split eh (#3120) 2018-07-16 22:25:02 -04:00
contributing.md Replace gitter links with Discord. (#3368) 2018-07-11 00:01:56 -07:00
custom_quantum_functions.md Replace gitter links with Discord. (#3368) 2018-07-11 00:01:56 -07:00
documentation_best_practices.md Fix up info boxes. 2018-05-07 22:46:26 -07:00
documentation_templates.md Make arguments redo, subproject elimination (#1784) 2017-10-14 11:32:19 -10:00
eclipse.md Fixed typo of 'confid.h' to 'config.h' (#2448) 2018-02-28 16:43:15 -05:00
faq.md Overhaul the Getting Started section and add a FAQ section 2017-08-16 15:47:20 -04:00
faq_build.md Instruct macos users to use avr-gcc@7 (#3337) 2018-07-07 17:37:37 -07:00
faq_debug.md Trim trailing whitespace 2017-12-09 10:46:11 -05:00
faq_general.md Convert all headings to Title Case 2017-12-09 10:46:11 -05:00
faq_keymap.md More thoroughly document Bootmagic and Command (#2455) 2018-03-02 09:21:03 -08:00
feature_advanced_keycodes.md Overhaul to keycode related docs 2018-07-15 13:40:18 -04:00
feature_audio.md Overhaul to keycode related docs 2018-07-15 13:40:18 -04:00
feature_auto_shift.md Fix up info boxes. 2018-05-07 22:46:26 -07:00
feature_backlight.md Clarify that we actually have max 16 total backlight levels 2018-01-12 12:52:35 -05:00
feature_bluetooth.md Format keycode tables 2017-12-09 10:46:11 -05:00
feature_bootmagic.md Fix link to command page 2018-04-15 11:53:31 -04:00
feature_command.md More thoroughly document Bootmagic and Command (#2455) 2018-03-02 09:21:03 -08:00
feature_dynamic_macros.md Trim trailing whitespace 2017-12-09 10:46:11 -05:00
feature_grave_esc.md Format keycode tables 2017-12-09 10:46:11 -05:00
feature_hd44780.md Integrating Peter Fleury's HD44780 LCD library (#3209) 2018-07-15 13:31:45 -04:00
feature_key_lock.md Convert all headings to Title Case 2017-12-09 10:46:11 -05:00
feature_layouts.md Clarify the format for layout names 2018-01-19 11:58:19 -08:00
feature_leader_key.md Refresh & improve leader documentation page (#2990) 2018-05-26 11:29:02 -07:00
feature_macros.md Fix up info boxes. 2018-05-07 22:46:26 -07:00
feature_mouse_keys.md Fixed dead links (#2451) 2018-03-01 07:45:47 -08:00
feature_pointing_device.md Fix some of the more obvious typos 2017-12-09 10:46:11 -05:00
feature_ps2_mouse.md Trim trailing whitespace 2017-12-09 10:46:11 -05:00
feature_rgb_matrix.md Addition of hard brigtness limit for RGB_Matrix (#3299) 2018-07-03 12:52:04 -04:00
feature_rgblight.md Add rgblight mode 35 (R,G,B test mode) (#3114) 2018-06-04 08:10:39 -07:00
feature_space_cadet.md Fix some of the more obvious typos 2017-12-09 10:46:11 -05:00
feature_space_shift_cadet.md new planck keymap, new feature - hybrid shift/enter action key (great for small keyboards!) (#2100) 2017-12-14 00:20:44 -05:00
feature_stenography.md Improve state/chord handling and clean up namespace 2018-04-07 17:12:44 -04:00
feature_swap_hands.md Add keycodes for swap-hands feature. 2018-03-16 16:33:43 -04:00
feature_tap_dance.md fix a few simple typos (#3068) 2018-05-28 20:23:33 -07:00
feature_terminal.md Added command history to terminal with other bug fixes, added new song to song_list.h (#2855) 2018-05-01 13:39:46 -04:00
feature_thermal_printer.md Format keycode tables 2017-12-09 10:46:11 -05:00
feature_unicode.md Fix some of the more obvious typos 2017-12-09 10:46:11 -05:00
feature_userspace.md Talljoe's layout with common keymap. (#2764) 2018-04-21 10:48:30 -07:00
features.md Integrating Peter Fleury's HD44780 LCD library (#3209) 2018-07-15 13:31:45 -04:00
flashing.md Link to Atmel's flip is broken. (#2752) 2018-04-18 22:21:36 -04:00
fuse.txt convert docs to lowercase and underscores 2017-06-10 14:58:24 -04:00
getting_started_build_tools.md Instruct macos users to use avr-gcc@7 (#3337) 2018-07-07 17:37:37 -07:00
getting_started_getting_help.md Replace gitter links with Discord. (#3368) 2018-07-11 00:01:56 -07:00
getting_started_github.md Docs: Adjust prompt to be more recognizable (#3417) 2018-07-15 21:23:22 -07:00
getting_started_introduction.md Update config.h boilerplate to use #pragma once 2018-07-15 13:21:20 -04:00
getting_started_make_guide.md Lets split eh (#3120) 2018-07-16 22:25:02 -04:00
getting_started_vagrant.md Fix some of the more obvious typos 2017-12-09 10:46:11 -05:00
hand_wire.md Trim trailing whitespace 2017-12-09 10:46:11 -05:00
hardware.md Fix some of the more obvious typos 2017-12-09 10:46:11 -05:00
hardware_avr.md Fix up info boxes. 2018-05-07 22:46:26 -07:00
hardware_drivers.md Convert all headings to Title Case 2017-12-09 10:46:11 -05:00
hardware_keyboard_guidelines.md Remove bootloader key as it is no longer used (#3093) 2018-06-01 12:26:48 -07:00
how_keyboards_work.md Convert all headings to Title Case 2017-12-09 10:46:11 -05:00
index.html override hamburger placement 2018-05-14 08:56:41 -07:00
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 Trim trailing whitespace 2017-12-09 10:46:11 -05:00
keycode.txt Trim trailing whitespace 2017-12-09 10:46:11 -05:00
keycodes.md Overhaul to keycode related docs 2018-07-15 13:40:18 -04:00
keycodes_basic.md Clean up SEND_STRING keycodes and add media keys (#3214) 2018-06-28 08:55:04 -04:00
keycodes_us_ansi_shifted.md Trim trailing whitespace 2017-12-09 10:46:11 -05:00
keymap.md Fixes and updates to docs (#2611) 2018-03-25 16:44:17 -07:00
newbs.md Docs: add resources for git (#3390) 2018-07-13 08:52:15 -07:00
newbs_building_firmware.md Fix up info boxes. 2018-05-07 22:46:26 -07:00
newbs_flashing.md Fix up info boxes. 2018-05-07 22:46:26 -07:00
newbs_getting_started.md added some helpful notes to the documentation (#2981) 2018-05-22 12:48:33 -07:00
newbs_learn_more_resources.md Docs: add resources for git (#3390) 2018-07-13 08:52:15 -07:00
newbs_testing_debugging.md Add a newbie guide for people completely new to QMK (#2480) 2018-03-06 14:37:48 -08:00
porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md Fix some of the more obvious typos 2017-12-09 10:46:11 -05:00
power.txt Trim trailing whitespace 2017-12-09 10:46:11 -05:00
qmk.css Some more tweaks to make everything look nice 2018-05-07 23:42:41 -07:00
quantum_keycodes.md Trim trailing whitespace 2017-12-09 10:46:11 -05:00
README.md Fix readme and contributing hyperlinks 2018-05-24 00:00:20 -04:00
redirects.json Disable the glossary linking to fix #2498 (#2499) 2018-03-08 10:31:08 -08:00
reference_glossary.md Disable the glossary linking to fix #2498 (#2499) 2018-03-08 10:31:08 -08:00
sidebar.css override hamburger placement 2018-05-14 08:56:41 -07:00
sw.js Fix up info boxes. 2018-05-07 22:46:26 -07:00
understanding_qmk.md Fixed dead links (#2451) 2018-03-01 07:45:47 -08:00
unit_testing.md Trim trailing whitespace 2017-12-09 10:46:11 -05:00
usb_nkro.txt convert docs to lowercase and underscores 2017-06-10 14:58:55 -04:00

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.