Go to file

Drashna Jaelre c534a4c775 [Docs] Smallish overhaul of the docs (#5281 ) * Fix up Common functions doc * Add to extra commands to flashing doc * Rearrange and touch up Macros * Expand Newbs Flashing guide * Update process_record documentation * Add git to best practices name in sidebar * Expand FAQ for build/flashing * Add deprecated info to functions * Update docs/feature_macros.md Co-Authored-By: drashna <drashna@live.com> * Update docs/feature_macros.md Co-Authored-By: drashna <drashna@live.com> * Update docs/flashing.md Co-Authored-By: drashna <drashna@live.com> * Update docs/flashing.md Co-Authored-By: drashna <drashna@live.com> * Update docs/keymap.md Co-Authored-By: drashna <drashna@live.com> * Update docs/newbs_flashing.md Co-Authored-By: drashna <drashna@live.com> * Update docs/newbs_flashing.md Co-Authored-By: drashna <drashna@live.com> * Update docs/custom_quantum_functions.md Co-Authored-By: drashna <drashna@live.com> * Update docs/faq_build.md Co-Authored-By: drashna <drashna@live.com> * Update docs/feature_macros.md Co-Authored-By: drashna <drashna@live.com> * Update docs/keymap.md Co-Authored-By: drashna <drashna@live.com> * Fix up Common functions doc * Make pre-init example accurate * Update docs/custom_quantum_functions.md Co-Authored-By: drashna <drashna@live.com> * Zadig Driver catchall * Spelling Depriciated * Completely remove fn_actions section		2019-03-18 14:22:02 -07:00
.github	Tweak issue templates (capitalisation mostly) (#5133 )	2019-02-14 20:44:27 -08:00
.vscode	Xton's first keymap! (#2941 )	2018-05-12 08:52:11 -07:00
docs	[Docs] Smallish overhaul of the docs (#5281 )	2019-03-18 14:22:02 -07:00
drivers	Fix return value of i2c_readReg and i2c_receive (#5410 )	2019-03-15 08:55:07 -07:00
keyboards	[Keyboard] Reduce compile size of the Lily58 Keyboard (#5412 )	2019-03-18 14:21:10 -07:00
layouts	[Keymap] Jotix (#5424 )	2019-03-17 10:16:08 -07:00
lib	Revert changes to chibiOS-contrib (#4176 )	2018-10-19 12:42:28 -07:00
quantum	New RGB Matrix effect: Single color reactive (#5330 )	2019-03-17 10:38:51 -07:00
tests	Remove empty action_function()	2019-01-11 18:32:43 -08:00
tmk_core	Add avrdude split EE_HANDS flash commands (#5414 )	2019-03-15 14:05:50 -07:00
users	[Keymap] Arkag Userspace Update (#5438 )	2019-03-18 10:31:09 -07:00
util	Ask for your name when generating a new keyboard (#5214 )	2019-02-26 07:59:34 -08:00
.clang_complete	Vim Layout for Ergodox-EZ (mac only) (#2112 )	2017-12-11 21:06:05 -05:00
.clang-format	Add .clang-format file	2019-02-17 08:59:19 -08:00
.editorconfig	Fix .editorconfig to not mess with line endings	2018-02-03 15:20:44 -05:00
.gitattributes
.gitignore	Add Satisfaction75 to QMK, Enable EEPROM on stm32f072 (#5094 )	2019-02-13 08:03:26 -08:00
.gitmodules	Update .gitmodules	2017-11-16 15:09:45 -05:00
.travis.yml	Remove AUTOGEN and fix Travis Compiled Push scripts (#5077 )	2019-02-12 16:46:04 -08:00
autocomplete.sh	Make arguments redo, subproject elimination (#1784 )	2017-10-14 11:32:19 -10:00
book.json	adds redirects for docs	2017-08-19 08:31:54 -04:00
bootloader.mk	Add Teensy ++ 2.0 bootloader support	2018-05-08 20:08:17 -04:00
build_full_test.mk	Add SRC and OPT_DEFS when building tests	2017-07-20 10:17:31 -04:00
build_keyboard.mk	Add a mechanism for force building a particular community layout (#5027 )	2019-02-14 20:14:26 -08:00
build_layout.mk	Add a mechanism for force building a particular community layout (#5027 )	2019-02-14 20:14:26 -08:00
build_test.mk	Split common.mk into common.mk and common_features.mk	2017-06-18 21:22:22 +03:00
CODE_OF_CONDUCT.md	Update CODE_OF_CONDUCT.md	2018-08-01 15:20:02 -04:00
common_features.mk	Next set of split_common changes (#4974 )	2019-03-12 10:23:28 -07:00
common.mk	Move Split Common VPATH addition (#4716 )	2018-12-31 08:45:44 -08:00
Dockerfile	Align docker and vagrant base images (#4905 )	2019-03-17 10:36:59 -07:00
Doxyfile	Generate API docs from source code comments (#2491 )	2018-03-22 02:50:38 -04:00
doxygen-todo	Generate API docs from source code comments (#2491 )	2018-03-22 02:50:38 -04:00
LICENSE	add an explicit lisence file for github to pickup	2017-11-13 20:50:54 -05:00
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
Makefile	Shallow clone submodules. (#5279 )	2019-03-08 07:58:40 -08:00
message.mk	Treat too-large firmwares as an error, not a warning (#3956 )	2018-09-27 13:32:01 -07:00
readme.md	Add Atreus as an official board.	2018-08-16 12:01:34 -04:00
secrets.tar.enc	update building for .hex, secrets moving	2017-08-21 21:57:46 -04:00
shell.nix	shell.nix: Packages relocated in upstream cleanup	2018-12-22 15:09:58 -08:00
show_options.mk	Clean up debounce a bit (#5255 )	2019-03-04 07:44:46 -08:00
testlist.mk	Add basic infrastrucure for building full tests	2017-06-18 21:08:23 +03:00
Vagrantfile	Align docker and vagrant base images (#4905 )	2019-03-17 10:36:59 -07:00

readme.md

Quantum Mechanical Keyboard Firmware

This is a keyboard firmware based on the tmk_keyboard firmware with some useful features for Atmel AVR and ARM controllers, and more specifically, the OLKB product line, the ErgoDox EZ keyboard, and the Clueboard product line.

Documentation

See the official documentation on docs.qmk.fm

The docs are hosted on Gitbook and GitHub (they are synced). You can request changes by making a fork and pull request, or by clicking the "suggest an edit" link on any page of the docs.

Supported Keyboards

The project also includes community support for lots of other keyboards.

Maintainers

QMK is developed and maintained by Jack Humbert of OLKB with contributions from the community, and of course, Hasu. The OLKB product firmwares are maintained by Jack Humbert, the Ergodox EZ by Erez Zukerman, the Clueboard by Zach White, and the Atreus by Phil Hagelberg.

Official website

http://qmk.fm is the official website of QMK, where you can find links to this page, the documentation, and the keyboards supported by QMK.