|
|
9 жил өмнө | |
|---|---|---|
| doc | c9ca368008 replace jackhumbert with qmk | 9 жил өмнө |
| keyboards | 1becbcb013 readme formatting changes | 9 жил өмнө |
| lib | cfddec17d5 Add Google Test submodule | 10 жил өмнө |
| quantum | 13c394fba4 Merge pull request #1071 from dungdung/rgb_tweaks | 9 жил өмнө |
| tmk_core | 42ea912fde Merge pull request #1062 from luizribeiro/fix-win | 9 жил өмнө |
| util | ad1327cd00 accept numbers in travis build | 9 жил өмнө |
| .gitattributes | de58ec9738 Set eep files to binary mode | 10 жил өмнө |
| .gitignore | 53a2bf9215 added dvorak programmer layout | 10 жил өмнө |
| .gitmodules | cfddec17d5 Add Google Test submodule | 10 жил өмнө |
| .travis.yml | 616b8604b0 variable scope fix for travis | 9 жил өмнө |
| Dockerfile | 407f949e4b Reverted Dockerfile to put the CMD back | 9 жил өмнө |
| Makefile | f787f4291a Typo fixes | 9 жил өмнө |
| Vagrantfile | 8a9bf1f165 Update some obsolete references | 10 жил өмнө |
| build_keyboard.mk | 4348fb54d6 Merge pull request #960 from ofples/feature/combos | 9 жил өмнө |
| build_test.mk | 42baa6cf43 Disable map file creation when building tests | 10 жил өмнө |
| common.mk | 7edac212c8 separated into api files/folder | 9 жил өмнө |
| message.mk | 7eefb34e7c Detect failures when running multiple tests | 10 жил өмнө |
| readme.md | 1b20243092 Add gitter image, start update to qmk org | 9 жил өмнө |
| testlist.mk | 6d7cd639a5 Basic framework for parsing test targets | 10 жил өмнө |
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.