13ad650136
* Add a Docker build script * Add usage and error messages * Add -r to reads Thanks mechmerlin * Add keyboard:keymap form, improve script * Add target argument, change usage forms in script * Add check for more than 3 args in keyboard:keymap:target form * Change Docker base image to debian, use community repo This matches what qmk_compiler uses (https://github.com/qmk/qmk_compiler/blob/master/Dockerfile#L1). I've removed the maintainer as we now have a community build on Docker Hub (https://hub.docker.com/r/qmkfm/qmk_firmware). This Dockerfile will also be maintained by the community. * Change build command format to keyboard:keymap * Call make directly in container run command * Simplify script, remove 3-arg form * Add COPY to Dockerfile so images are usable in and of themselves Also change WORKDIR from /qmk to /qmk_firmware * Add USB pass-through for Linux and docker-machine hosts * Read directly into variables instead of array * Alphabetically sort dependencies in Dockerfile * Set executable bit on util/docker_build.sh * Update Docker docs * Add warning about Docker on Windows * Expand comment in docs * Check docker-machine exit code instead of string * Only match --help with whole arguments * Make script POSIX-compliant * Convert script indentation to tabs |
||
|---|---|---|
| .github | ||
| .vscode | ||
| docs | ||
| drivers | ||
| keyboards | ||
| layouts | ||
| lib | ||
| quantum | ||
| tests | ||
| tmk_core | ||
| users | ||
| util | ||
| .clang_complete | ||
| .editorconfig | ||
| .gitattributes | ||
| .gitignore | ||
| .gitmodules | ||
| .travis.yml | ||
| autocomplete.sh | ||
| book.json | ||
| bootloader.mk | ||
| build_full_test.mk | ||
| build_keyboard.mk | ||
| build_layout.mk | ||
| build_test.mk | ||
| CODE_OF_CONDUCT.md | ||
| common.mk | ||
| common_features.mk | ||
| Dockerfile | ||
| Doxyfile | ||
| doxygen-todo | ||
| LICENSE | ||
| license_GPLv2.md | ||
| license_GPLv3.md | ||
| license_Modified_BSD.md | ||
| Makefile | ||
| message.mk | ||
| readme.md | ||
| secrets.tar.enc | ||
| shell.nix | ||
| testlist.mk | ||
| Vagrantfile | ||
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 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.