You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Go to file
jorgemanzo 897888db41 Add CLI command for flashing a keyboard
A new CLI subcommand was added, flash, which behaves very similar to the already present compile CLI comamnd, but with the added ability to target a bootloader. The command is used like so: qmk flash [-h] [-b] [-kb KEYBOARD] [-km KEYMAP] [-bl BOOTLOADER] [filename].

A -kb <keyboard> and -km <keymap> is expected, or a configurator export JSON filename. A bootloader can be specified using -bl <target>, and if left unspecified, the target is assumed to be :flash. -bl can be used to list the available bootloaders.

If -km <keymap> is provided, but no -kb <keyboard>, then a message is printed suggesting the user to run qmk list_keyboards.
6 years ago
.github [GitHub] Update issue templates (#7303) 6 years ago
.vscode Generalize Tap Dance Layer functions (#6629) 6 years ago
bin Fix "could not find module" error message formatting (#7219) 6 years ago
docs Add CLI command for flashing a keyboard 6 years ago
drivers Improvements to Solenoid feature (#7369) 6 years ago
keyboards Port SPLIT_USB_DETECT to crkbd (#7195) 6 years ago
layouts [Keymap] add_mouse_keys (#7372) 6 years ago
lib Add CLI command for flashing a keyboard 6 years ago
quantum Updated slave encoder sync to reduce dropped pulses (#7325) 6 years ago
tests clang-format changes 6 years ago
tmk_core Add support for configurable polling interval and power usage o… (#7336) 6 years ago
users [Keymap] Added Xulkal ALT Keymap (#7332) 6 years ago
util Update ARM GCC on macOS to 8.3 (#7318) 6 years ago
.clang-format fix indent size 6 years ago
.clang_complete Vim Layout for Ergodox-EZ (mac only) (#2112) 7 years ago
.editorconfig QMK CLI and JSON keymap support (#6176) 6 years ago
.gitattributes
.gitignore [Docs] Update hand wire guide (#7044) 6 years ago
.gitmodules add lufa as a submodule 6 years ago
.travis.yml CI - Fix change detection (#7038) 6 years ago
CODE_OF_CONDUCT.md updates the coc 6 years ago
Dockerfile Update docker util script and travis to use new base container 6 years ago
Doxyfile Generate API docs from source code comments (#2491) 7 years ago
LICENSE add an explicit lisence file for github to pickup 8 years ago
Makefile Set `git submodule update` depth to 50 (#7269) 6 years ago
Vagrantfile Configure Vagrant to use qmk_base_container (#6194) 6 years ago
autocomplete.sh Make arguments redo, subproject elimination (#1784) 8 years ago
book.json adds redirects for docs 8 years ago
bootloader.mk Update bootloader.mk (#6698) 6 years ago
build_full_test.mk Add SRC and OPT_DEFS when building tests 8 years ago
build_json.mk Make generating keymap.c from JSON more reliable 6 years ago
build_keyboard.mk add 'objs-size' target into tmk_core/avr.mk (#5490) 6 years ago
build_layout.mk Add a mechanism for force building a particular community layout (#5027) 6 years ago
build_test.mk Split common.mk into common.mk and common_features.mk 8 years ago
common.mk Move Split Common VPATH addition (#4716) 6 years ago
common_features.mk [Core] Convert Dynamic Macro to a Core Feature (#5948) 6 years ago
doxygen-todo Generate API docs from source code comments (#2491) 7 years ago
license_GPLv2.md Clarify the quantum license (#1042) 8 years ago
license_GPLv3.md Clarify the quantum license (#1042) 8 years ago
license_Modified_BSD.md Clarify the quantum license (#1042) 8 years ago
message.mk Add list-keymaps make target (#5563) 6 years ago
nose2.cfg Setup a python test framework 6 years ago
readme.md [Docs] Fix missing link in readme (#6958) 6 years ago
requirements.txt Add cli convert subcommand, from raw KLE to JSON (#6898) 6 years ago
secrets.tar.enc update building for .hex, secrets moving 8 years ago
setup.cfg QMK CLI and JSON keymap support (#6176) 6 years ago
shell.nix Fix shell.nix by pinning nixpkgs (#6213) 6 years ago
show_options.mk Add Dip Switch as a core feature (#6140) 6 years ago
testlist.mk Add basic infrastrucure for building full tests 8 years ago

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 powered by Docsify and hosted on GitHub. You can request changes by making a fork and pull request, or by clicking the "Edit Document" link at the bottom of any page.

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.