marco/qmk
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
7,287 Commits 2 Branches 0 Tags 300 MiB
C 91.2%
C++ 5.7%
Python 1.7%
Makefile 1.2%
7c9d5ace14
Go to file
skullydazed 7c9d5ace14 Generate API docs from source code comments (#2491) 
* Generate api docs from source code

* Add a bunch of doxygen comments

* more doxygen comments

* Add the in-progress api docs

* script to generate docs from travis

* Add doc generation to the travis job

* make travis_docs.sh commit the work it does

* make sure the docs script exits cleanly
2018-03-22 02:50:38 -04:00
.vscode
docs Generate API docs from source code comments (#2491) 2018-03-22 02:50:38 -04:00
drivers
keyboards Update info.json for Ergodox EZ (#2577) 2018-03-21 03:09:51 -04:00
layouts retry of PR #2540 (#2554) 2018-03-18 00:21:01 -04:00
lib Merge ChibiOS and LUFA descriptor support (#2362) 2018-02-08 15:07:46 -05:00
quantum Add macro for momentarily switching to a layer while some mods are active (#2460) 2018-03-20 22:59:54 -04:00
tests add tests for action_layer.c and reset layer state after tests 2017-12-15 13:23:30 -05:00
tmk_core Generate API docs from source code comments (#2491) 2018-03-22 02:50:38 -04:00
users Add Pretty Keymaps to Ergodox EZ 2018-03-20 20:23:08 -04:00
util Generate API docs from source code comments (#2491) 2018-03-22 02:50:38 -04:00
.clang_complete Vim Layout for Ergodox-EZ (mac only) (#2112) 2017-12-11 21:06:05 -05:00
.editorconfig Fix .editorconfig to not mess with line endings 2018-02-03 15:20:44 -05:00
.gitattributes
.gitignore Generate API docs from source code comments (#2491) 2018-03-22 02:50:38 -04:00
.gitmodules Update .gitmodules 2017-11-16 15:09:45 -05:00
.travis.yml Generate API docs from source code comments (#2491) 2018-03-22 02:50:38 -04:00
autocomplete.sh
book.json
bootloader.mk Updates bootloader settings, adds file size check (#2029) 2017-11-27 23:08:21 -05:00
build_full_test.mk
build_keyboard.mk Merge ChibiOS and LUFA descriptor support (#2362) 2018-02-08 15:07:46 -05:00
build_layout.mk
build_test.mk
CODE_OF_CONDUCT.md
common_features.mk Rule to enable Modifiers with Auto-Shift (#2542) 2018-03-16 16:41:01 -04:00
common.mk
Dockerfile
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 Added a clean target to remove build artifacts 2018-03-16 16:44:22 -04:00
message.mk Reset color after submodule warning message 2018-01-12 13:25:05 -05:00
readme.md Found some broken links while looking up ARM keyboard support 2017-12-15 13:23:52 -05:00
secrets.tar.enc
shell.nix shell.nix: add teensy loader 2017-11-26 17:55:24 -05:00
testlist.mk
Vagrantfile

readme.md

Quantum Mechanical Keyboard Firmware

Current Version Build Status Gitter Docs Status GitHub contributors GitHub forks

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.

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.

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, and the Clueboard by Zach White.

Documentation

https://docs.qmk.fm is 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.