forksand
/
qmk_firmware
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
Copy of https://github.com/qmk/qmk_firmware Modified for our keyboard.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
4475 Commits
79 Branches
743 Tags
226 MiB
 
 
 
 
 
 
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '06e4b3fe1a'
${ noResults }
Go to file
Kevin Hogeland 06e4b3fe1a
Colemak layout for Clueboard 		8 years ago
doc replace jackhumbert with qmk 8 years ago
keyboards Colemak layout for Clueboard 8 years ago
lib Add Google Test submodule 8 years ago
quantum Left control and alt 8 years ago
tmk_core Removes redundant {} which cause build failure when DEBUG_ACTION is set 8 years ago
util Add freebsd support in "util/install_dependencies.sh" 8 years ago
.gitattributes Set eep files to binary mode 8 years ago
.gitignore added dvorak programmer layout 8 years ago
.gitmodules Add Google Test submodule 8 years ago
.travis.yml send travis stuff to gitter 8 years ago
Dockerfile Reverted Dockerfile to put the CMD back 8 years ago
Makefile Typo fixes 8 years ago
Vagrantfile Update some obsolete references 8 years ago
build_keyboard.mk add unicode common file, get names right 8 years ago
build_test.mk Disable map file creation when building tests 8 years ago
common.mk separated into api files/folder 8 years ago
message.mk Detect failures when running multiple tests 8 years ago
readme.md update travis badge 8 years ago
testlist.mk Basic framework for parsing test targets 8 years ago

readme.md

Quantum Mechanical Keyboard Firmware

Build Status Gitter

This is a keyboard firmware based on the tmk_keyboard firmware with some useful features for Atmel AVR controllers, and more specifically, the OLKB product line, the ErgoDox EZ keyboard, and the Clueboard product line.

Official website (currently under construction with the move to the wiki)

For an easy-to-read version of this document and the repository, check out http://qmk.fm. Nicely formatted keyboard and keymap listings are also available there, along with the ability to download .hex files instead of having to setup a build environment and compile them.

Included 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. This repo used to be a fork of TMK, and we are incredibly grateful for his founding contributions to the firmware. We've had to break the fork due to purely technical reasons - it simply became too different over time, and we've had to start refactoring some of the basic bits and pieces. We are huge fans of TMK and Hasu :)

This documentation is edited and maintained by Erez Zukerman of ErgoDox EZ. If you spot any typos or inaccuracies, please open an issue.

The OLKB product firmwares are maintained by Jack Humbert, the Ergodox EZ by Erez Zukerman, and the Clueboard by Zach White.

Documentation roadmap

This is not a tiny project. While this is the main readme, there are many other files you might want to consult. Here are some points of interest:

  • The Wiki - the entirety of the readme has been moved here
  • The readme for your own keyboard: This is found under keyboards/<your keyboards's name>/. So for the ErgoDox EZ, it's here; for the Planck, it's here and so on.
  • The list of possible keycodes you can use in your keymap is actually spread out in a few different places:
    • doc/keycode.txt - an explanation of those same keycodes.
    • quantum/keymap.h - this is where the QMK-specific aliases are all set up. Things like the Hyper and Meh key, the Leader key, and all of the other QMK innovations. These are also explained and documented below, but keymap.h is where they're actually defined.
  • The TMK documentation. QMK is based on TMK, and this explains how it works internally.