|
|
9 years ago | |
|---|---|---|
| doc | 64218f0f70 Add proper shortcode for KC_DELETE to keycode.txt | 9 years ago |
| keyboards | ca9a3dcb71 Fix unrelated spelling error | 9 years ago |
| lib | cfddec17d5 Add Google Test submodule | 10 years ago |
| quantum | 460bf008f5 Merge pull request #973 from Wilba6582/keycode_refactor | 9 years ago |
| tmk_core | 460bf008f5 Merge pull request #973 from Wilba6582/keycode_refactor | 9 years ago |
| util | 5f9c2f63ff Merge pull request #761 from runcom/fix-yum-installs | 10 years ago |
| .gitattributes | de58ec9738 Set eep files to binary mode | 10 years ago |
| .gitignore | 53a2bf9215 added dvorak programmer layout | 9 years ago |
| .gitmodules | cfddec17d5 Add Google Test submodule | 10 years ago |
| .travis.yml | 83eb9e4eed Fix the .travis.yml so that GH_TOKEN works properly | 10 years ago |
| Dockerfile | 3d7aaa31e4 converted to 8bit messages | 9 years ago |
| Makefile | 1d1f2b4ee2 Clean up the SKIP_GIT code | 9 years ago |
| Vagrantfile | 8a9bf1f165 Update some obsolete references | 10 years ago |
| build_keyboard.mk | 6e0f994950 Merge branch 'master' of github.com:jackhumbert/qmk_firmware into wu5y7 | 9 years ago |
| build_test.mk | 42baa6cf43 Disable map file creation when building tests | 10 years ago |
| common.mk | 7edac212c8 separated into api files/folder | 9 years ago |
| message.mk | 7eefb34e7c Detect failures when running multiple tests | 10 years ago |
| readme.md | 985a091a73 Update readme.md | 9 years ago |
| testlist.mk | 6d7cd639a5 Basic framework for parsing test targets | 10 years ago |
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.
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.
The project also includes community support for lots of other keyboards.
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.
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:
keyboards/<your keyboards's name>/. So for the ErgoDox EZ, it's here; for the Planck, it's here and so on.keymap.h is where they're actually defined.