d569f08771
* Rework how bin/qmk handles subcommands * qmk config wip * Code to show all configs * Fully working `qmk config` command * Mark some CLI arguments so they don't pollute the config file * Fleshed out config support, nicer subcommand support * sync with installable cli * pyformat * Add a test for subcommand_modules * Documentation for the `qmk config` command * split config_token on space so qmk config is more predictable * Rework how subcommands are imported * Document `arg_only` * Document deleting from CLI * Document how multiple operations work * Add cli config to the doc index * Add tests for the cli commands * Make running the tests more reliable * Be more selective about building all default keymaps * Update new-keymap to fit the new subcommand style * Add documentation about writing CLI scripts * Document new-keyboard * Update docs/cli_configuration.md Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Update docs/cli_development.md Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Update docs/cli_development.md Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Update docs/cli_development.md Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Address yan's comments. * Apply suggestions from code review suggestions from @noahfrederick Co-Authored-By: Noah Frederick <code@noahfrederick.com> * Apply suggestions from code review Co-Authored-By: Noah Frederick <code@noahfrederick.com> * Remove pip3 from the test runner |
6 years ago | |
|---|---|---|
| .github | 7 years ago | |
| .vscode | 6 years ago | |
| bin | 6 years ago | |
| docs | 6 years ago | |
| drivers | 6 years ago | |
| keyboards | 6 years ago | |
| layouts | 6 years ago | |
| lib | 6 years ago | |
| quantum | 6 years ago | |
| tests | 6 years ago | |
| tmk_core | 6 years ago | |
| users | 6 years ago | |
| util | 6 years ago | |
| .clang-format | 7 years ago | |
| .clang_complete | ||
| .editorconfig | 6 years ago | |
| .gitattributes | ||
| .gitignore | 6 years ago | |
| .gitmodules | 6 years ago | |
| .travis.yml | 6 years ago | |
| CODE_OF_CONDUCT.md | 6 years ago | |
| Dockerfile | 6 years ago | |
| Doxyfile | ||
| LICENSE | ||
| Makefile | 6 years ago | |
| Vagrantfile | 6 years ago | |
| autocomplete.sh | ||
| book.json | ||
| bootloader.mk | 6 years ago | |
| build_full_test.mk | ||
| build_json.mk | 6 years ago | |
| build_keyboard.mk | 6 years ago | |
| build_layout.mk | 7 years ago | |
| build_test.mk | ||
| common.mk | 7 years ago | |
| common_features.mk | 6 years ago | |
| doxygen-todo | ||
| license_GPLv2.md | ||
| license_GPLv3.md | ||
| license_Modified_BSD.md | ||
| message.mk | 6 years ago | |
| nose2.cfg | 6 years ago | |
| readme.md | 6 years ago | |
| requirements.txt | 6 years ago | |
| secrets.tar.enc | ||
| setup.cfg | 6 years ago | |
| shell.nix | 6 years ago | |
| show_options.mk | 6 years ago | |
| testlist.mk | ||
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
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.