alvierahman90/qmk_firmware
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Open-source keyboard firmware for Atmel AVR and Arm USB families https://qmk.fm
3,880 Commits 48 Branches 349 Tags 167 MiB
C 90.3%
Makefile 4.2%
C++ 4.1%
Python 0.7%
Objective-C 0.5%
4cf0f7dd16
Go to file
lucwastiaux 4cf0f7dd16 make shell layer more compatible with default layer
2017-01-21 23:42:23 +08:00
doc Add proper shortcode for KC_DELETE to keycode.txt 2016-11-08 22:05:24 -05:00
keyboards make shell layer more compatible with default layer 2017-01-21 23:42:23 +08:00
lib Add Google Test submodule 2016-08-27 21:57:49 +03:00
quantum Merge pull request #914 from wez/ble_2 2016-12-02 13:12:56 -05:00
tmk_core Merge pull request #921 from Wilba6582/raw_hid 2016-12-05 00:13:37 -05:00
util Merge pull request #761 from runcom/fix-yum-installs 2016-09-19 01:22:38 -04:00
.gitattributes Set eep files to binary mode 2016-08-27 18:37:28 +03:00
.gitignore added dvorak programmer layout 2016-10-22 22:22:34 +08:00
.gitmodules Add Google Test submodule 2016-08-27 21:57:49 +03:00
.travis.yml Fix the .travis.yml so that GH_TOKEN works properly 2016-08-28 01:10:14 +03:00
build_keyboard.mk Merge branch 'master' of github.com:jackhumbert/qmk_firmware into wu5y7 2016-11-28 23:51:07 -05:00
build_test.mk Disable map file creation when building tests 2016-08-27 21:57:49 +03:00
common.mk separated into api files/folder 2016-11-26 15:38:44 -05:00
Dockerfile converted to 8bit messages 2016-11-23 00:30:06 -05:00
Makefile Adding SKIP_GIT to speed up compiles. 2016-11-01 11:52:58 -05:00
message.mk Detect failures when running multiple tests 2016-08-27 21:57:49 +03:00
readme.md Update readme.md 2016-12-06 09:49:05 -05:00
testlist.mk Basic framework for parsing test targets 2016-08-27 21:57:49 +03:00
Vagrantfile Update some obsolete references 2016-07-30 08:37:30 +02:00

readme.md

Quantum Mechanical Keyboard Firmware

Build Status

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 entirity 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.