How to Start

At this time no tutorial for this, but you can consult with under tmk_core/doc/ and wiki pages first.

• https://github.com/tmk/tmk_keyboard/tree/master/tmk_core/doc

• https://github.com/tmk/tmk_keyboard/wiki

In the end you have to read source codes. You can start with check codes under keyboard/ to get rough idea on how to define your keyboard, alps64 and gh60 are probably preferable. You will have to implement matrix_init() and matrix_scan() at least.

And you will have to read codes under tmk_core/common(and tmk_core/protocol/lufa) to know how it works under the hood. You want to start with common/keyboard.c first, especially keyboard_task() in which the matrix_scan() is called.

Also you can ask question in this thread.

• https://geekhack.org/index.php?topic=41989.msg841759#msg841759

Good luck with your project!