cub-uanic / tmk_keyboard

keyboard controller firmware for Atmel AVR USB family
158 stars 157 forks source link

Updated ErgoDox build section. Added barebones template. #40

Closed wobbol closed 8 years ago

wobbol commented 8 years ago

The build section in the ErgoDox readme was incorrect. the old layout name passing method no longer works because, a layout is not a target. The new way to specify Layout names is `KEYMAP=[desired keymap]'

Added a tiny primer on making new layouts. Added a tiny template keymap to keep the verbosity down.

wobbol commented 8 years ago

I do not clearly understand if my new section fulfills the promise of the TODO. Let me know if I need to remove that.

cheers.

marknsikora commented 8 years ago

Looks good to me. My only concern is that the naming of the template file would allow someone to run

make -f Makefile.lufa KEYMAP=template

And some lazy users might just stick everything in the template file instead of copying it and making their own layout.

wobbol commented 8 years ago

You are right, keymap_template.c is not a good name. I would like to keep the name of the template in the same form though. How about adding something to the end like this keymap_name.c.template?

Or maybe, instead of a template, I should give a working layout with the bare minimum?

Also, I am worried about this not getting merged here. Is there a more active fork that supports ErgoDox?

wobbol commented 8 years ago

Finally remembered to do this. :)

wobbol commented 8 years ago

bump.

wobbol commented 8 years ago

I've ported these changes over to Ergodox/ergodox#3. This pull is now obsolete.