|
|
9 лет назад | |
|---|---|---|
| doc | 154305ce1b Fix formatting in BUILD_GUIDE.md (#1208) | 9 лет назад |
| keyboards | 967cf0f6d4 Merge remote-tracking branch 'upstream/master' into user_led_configuration | 9 лет назад |
| lib | cfddec17d5 Add Google Test submodule | 10 лет назад |
| quantum | a1e156a3d2 dynamic_macro.h: Do not use backlight_toggle if backlight is disabled | 9 лет назад |
| tmk_core | 18b4d24cc3 Add possibility to override the command to execute when flashing | 9 лет назад |
| util | a9959783c0 Add freebsd support in "util/install_dependencies.sh" | 9 лет назад |
| .gitattributes | de58ec9738 Set eep files to binary mode | 10 лет назад |
| .gitignore | 96bde794d8 Update readme and default layout for TADA68 | 9 лет назад |
| .gitmodules | cfddec17d5 Add Google Test submodule | 10 лет назад |
| .travis.yml | a773124537 send travis stuff to gitter | 9 лет назад |
| Dockerfile | 7ce94eb468 Cleaning Up Dockerfile Layers Per Official Docs | 9 лет назад |
| Makefile | 738b8d2b9c Add SKIP_VERSION option to speed up compilation | 9 лет назад |
| Vagrantfile | 8a9bf1f165 Update some obsolete references | 10 лет назад |
| build_keyboard.mk | d8e2ff2964 Fix process_unicode_common.c being included twice | 9 лет назад |
| build_test.mk | 42baa6cf43 Disable map file creation when building tests | 10 лет назад |
| common.mk | 7edac212c8 separated into api files/folder | 9 лет назад |
| license_GPLv2.md | 23839b8c6d Clarify the quantum license (#1042) | 9 лет назад |
| license_GPLv3.md | 23839b8c6d Clarify the quantum license (#1042) | 9 лет назад |
| license_Modified_BSD.md | 23839b8c6d Clarify the quantum license (#1042) | 9 лет назад |
| message.mk | 7eefb34e7c Detect failures when running multiple tests | 10 лет назад |
| readme.md | 570b4605b2 Update readme.md | 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, it's here; for the Planck, it's here and so on.quantum_keycodes.h is where they're actually defined.