marco/qmk
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
10,832 Commits 2 Branches 0 Tags 300 MiB
C 91.2%
C++ 5.7%
Python 1.7%
Makefile 1.2%
2707652c98
Go to file
fauxpark 2707652c98 [Docs] CLI command to serve docs locally (#6956) 
* CLI command to serve docs locally

* Document it

* Default port

* Use `with` and subclass `SimpleHTTPRequestHandler` to set working dir

* Apply suggestions from code review

Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>

* Update docs/cli.md
2019-10-08 11:06:26 -07:00
.github
.vscode
bin
docs [Docs] CLI command to serve docs locally (#6956) 2019-10-08 11:06:26 -07:00
drivers [Keyboard] RGB updates on NK65 and HS60 (#6795) 2019-10-08 09:03:51 -07:00
keyboards [Keyboard] RGB updates on NK65 and HS60 (#6795) 2019-10-08 09:03:51 -07:00
layouts [Keymap] Community layout for hhkb (#6961) 2019-10-07 13:31:11 -07:00
lib [Docs] CLI command to serve docs locally (#6956) 2019-10-08 11:06:26 -07:00
quantum
tests
tmk_core
users [Keymap] Overly greedy community keymap build userspace (#6969) 2019-10-07 19:23:59 -07:00
util
.clang_complete
.clang-format
.editorconfig
.gitattributes
.gitignore
.gitmodules
.travis.yml removed deprecated option for Travis (#6896) 2019-10-05 12:04:46 -07:00
autocomplete.sh
book.json
bootloader.mk
build_full_test.mk
build_json.mk
build_keyboard.mk
build_layout.mk
build_test.mk
CODE_OF_CONDUCT.md
common_features.mk
common.mk
Dockerfile
Doxyfile
doxygen-todo
LICENSE
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
Makefile
message.mk
nose2.cfg
readme.md
requirements.txt
secrets.tar.enc
setup.cfg
shell.nix
show_options.mk
testlist.mk
Vagrantfile

readme.md

Quantum Mechanical Keyboard Firmware

Current Version Build Status Discord 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.

Documentation

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 ZSA Technology Labs, the Clueboard by Zach White, and the Atreus by Phil Hagelberg.

Official Website

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