|
|
9 ani în urmă | |
|---|---|---|
| doc | 154305ce1b Fix formatting in BUILD_GUIDE.md (#1208) | 9 ani în urmă |
| keyboards | 02ef122cbb Add led_controller.h to user keymap.c | 9 ani în urmă |
| lib | cfddec17d5 Add Google Test submodule | 10 ani în urmă |
| quantum | de52bd5d89 quick fix for space cadet shift | 9 ani în urmă |
| tmk_core | 3448d5d487 Merge pull request #1132 from akatrevorjay/pr/dfu-serial | 9 ani în urmă |
| util | a9959783c0 Add freebsd support in "util/install_dependencies.sh" | 9 ani în urmă |
| .gitattributes | de58ec9738 Set eep files to binary mode | 10 ani în urmă |
| .gitignore | 96bde794d8 Update readme and default layout for TADA68 | 9 ani în urmă |
| .gitmodules | cfddec17d5 Add Google Test submodule | 10 ani în urmă |
| .travis.yml | a773124537 send travis stuff to gitter | 9 ani în urmă |
| Dockerfile | 407f949e4b Reverted Dockerfile to put the CMD back | 9 ani în urmă |
| Makefile | f787f4291a Typo fixes | 9 ani în urmă |
| Vagrantfile | 8a9bf1f165 Update some obsolete references | 10 ani în urmă |
| build_keyboard.mk | b911e1966f Fix redundant process_music.c in sources | 9 ani în urmă |
| build_test.mk | 42baa6cf43 Disable map file creation when building tests | 10 ani în urmă |
| common.mk | 7edac212c8 separated into api files/folder | 9 ani în urmă |
| license_GPLv2.md | 23839b8c6d Clarify the quantum license (#1042) | 9 ani în urmă |
| license_GPLv3.md | 23839b8c6d Clarify the quantum license (#1042) | 9 ani în urmă |
| license_Modified_BSD.md | 23839b8c6d Clarify the quantum license (#1042) | 9 ani în urmă |
| message.mk | 7eefb34e7c Detect failures when running multiple tests | 10 ani în urmă |
| readme.md | 570b4605b2 Update readme.md | 9 ani în urmă |
| testlist.mk | 6d7cd639a5 Basic framework for parsing test targets | 10 ani în urmă |
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, it's here; for the Planck, it's here and so on.quantum_keycodes.h is where they're actually defined.