Keyboard firmwares for Atmel AVR and Cortex-M
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.md 6.7KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133
  1. GH60 keyboard firmware
  2. ======================
  3. DIY compact keyboard designed and run by komar007 and Geekhack community.
  4. ## Threads on Geekhack.org
  5. - [Prototyping](http://geekhack.org/index.php?topic=34959.0)
  6. - [Beta-test](http://geekhack.org/index.php?topic=37570.0)
  7. ## Build
  8. Move to this directory then just run `make` like:
  9. $ make
  10. Use `make -f Makefile.pjrc` if you want to use PJRC stack but I find no reason to do so now.
  11. ## Keymap
  12. Several version of keymap are available; `plain`, `poker_bit`, `poker_set`, `hasu` and `poker`(default). See keymap document(you can find in README.md of top) and `keymap_*.c` to define your own favourite keymap.
  13. $ make KEYMAP=[poker|plain|poker_set|poker_bit|hasu]
  14. ### 1. Plain keymap
  15. Even without any Fn layer. This will be useful if you want to use key mapping tool like AHK.
  16. See [keymap_plain.c](keymap_plain.c) for detail.
  17. #### 1.0 Plain Default Layer
  18. ,-----------------------------------------------------------.
  19. |Esc| 1| 2| 3| 4| 5| 6| 7| 8| 9| 0| -| =|Backsp |
  20. |-----------------------------------------------------------|
  21. |Tab | Q| W| E| R| T| Y| U| I| O| P| [| ]| \|
  22. |-----------------------------------------------------------|
  23. |Caps | A| S| D| F| G| H| J| K| L| ;| '|Return |
  24. |-----------------------------------------------------------|
  25. |Shift | Z| X| C| V| B| N| M| ,| .| /|Shift |
  26. |-----------------------------------------------------------|
  27. |Ctrl|Gui |Alt | Space |Alt |Gui |App |Ctrl|
  28. `-----------------------------------------------------------'
  29. ### 2 Poker keymap
  30. [keymap_poker.c](keymap_poker.c) emulates original Poker layer emulation.
  31. [keymap_poker_bit.c](keymap_poker_bit.c) and [keymap_poker_set.c](keymap_poker_set.c) offers better support of Esc and arrow like:
  32. Fn + Esc = `
  33. Fn + {left, down, up, right} = {home, pgdown, pgup, end}
  34. `poker` keymap supports Colemak, Dvorak and Workmans, use `Magic` + {`1`, `2`, `3`} to switch and `Magic` + `0` to return to Qwerty, where `Magic` is `LShift` + `RShift`.
  35. #### 2.0 Poker Default Layer
  36. ,-----------------------------------------------------------.
  37. | `| 1| 2| 3| 4| 5| 6| 7| 8| 9| 0| -| =|Backsp |
  38. |-----------------------------------------------------------|
  39. |Tab | Q| W| E| R| T| Y| U| I| O| P| [| ]| \|
  40. |-----------------------------------------------------------|
  41. |Caps | A| S| D| F| G| H| J| K| L| ;| '|Return |
  42. |-----------------------------------------------------------|
  43. |Shift | Z| X| C| V| B| N| M| ,| .| /|Shift |
  44. |-----------------------------------------------------------|
  45. |Ctrl|Gui |Alt | Space |Fn |Gui |App |Ctrl|
  46. `-----------------------------------------------------------'
  47. #### 2.1 Poker Fn Layer
  48. ,-----------------------------------------------------------.
  49. |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12| |
  50. |-----------------------------------------------------------|
  51. | |FnQ| Up| | | | | | |Cal| |Hom|Ins| |
  52. |-----------------------------------------------------------|
  53. | |Lef|Dow|Rig| | |Psc|Slk|Pau| |Tsk|End| |
  54. |-----------------------------------------------------------|
  55. | |Del| |Web|Mut|VoU|VoD| |PgU|PgD|Del| Up |
  56. |-----------------------------------------------------------|
  57. | | | | FnS |Fn |Left|Down|Righ|
  58. `-----------------------------------------------------------'
  59. ### 3. Hasu keymap
  60. This is my keymap with HHKB, Vi cursor and Mousekey layer. See [keymap_hasu.c](keymap_hasu.c) for detail.
  61. #### 3.0 Funky Default Layer
  62. ,-----------------------------------------------------------.
  63. |Esc| 1| 2| 3| 4| 5| 6| 7| 8| 9| 0| -| =|Backsp |
  64. |-----------------------------------------------------------|
  65. |Tab | Q| W| E| R| T| Y| U| I| O| P| [| ]| \|
  66. |-----------------------------------------------------------|
  67. |Caps | A| S| D| F| G| H| J| K| L|*L3| '|Return |
  68. |-----------------------------------------------------------|
  69. |Shift | Z| X| C| V| B| N| M| ,| .|*L2|Shift |
  70. |-----------------------------------------------------------|
  71. |Ctrl|Gui |Alt | Space |Alt |*L3 |*L3 |*L1 |
  72. `-----------------------------------------------------------'
  73. #### 3.1 Funky HHKB mode
  74. ,-----------------------------------------------------------.
  75. |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Delete |
  76. |-----------------------------------------------------------|
  77. |Caps | | | | | | | |Psc|Slk|Pus|Up | |Inser|
  78. |-----------------------------------------------------------|
  79. |Contro|VoD|VoU|Mut| | | *| /|Hom|PgU|Lef|Rig|Enter |
  80. |-----------------------------------------------------------|
  81. |Shift | | | | | | +| -|End|PgD|Dow|Shift |
  82. |-----------------------------------------------------------|
  83. |Ctrl|Gui |Alt | Space |Alt |Gui |App |*L0 |
  84. `-----------------------------------------------------------'
  85. #### 3.2 Funky Vi mode
  86. ,-----------------------------------------------------------.
  87. | `| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Backsp |
  88. |-----------------------------------------------------------|
  89. |Tab |Hom|PgD|Up |PgU|End|Hom|PgD|PgU|End| | | | |
  90. |-----------------------------------------------------------|
  91. |Contro| |Lef|Dow|Rig| |Lef|Dow|Up |Rig| | |Return |
  92. |-----------------------------------------------------------|
  93. |Shift | | | | | |Hom|PgD|PgU|End|*L0|Shift |
  94. |-----------------------------------------------------------|
  95. |Ctrl|Gui |Alt | Space |Alt |Gui |App |Ctrl|
  96. `-----------------------------------------------------------'
  97. #### 3.3 Funky Mouse mode
  98. ,-----------------------------------------------------------.
  99. | `| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Backsp |
  100. |-----------------------------------------------------------|
  101. |Tab |MwL|MwD|McU|MwU|MwR|MwL|MwD|MwU|MwR| | | | |
  102. |-----------------------------------------------------------|
  103. |Contro| |McL|McD|McR| |McL|McD|McU|McR|*L0| |Return |
  104. |-----------------------------------------------------------|
  105. |Shift | | |Mb1|Mb2|Mb3|Mb2|Mb1| | | |Shift |
  106. |-----------------------------------------------------------|
  107. |Ctrl|Gui |Alt | Space |Alt |*L0 |*L0 |Ctrl|
  108. `-----------------------------------------------------------'
  109. Mc: Mouse Cursor / Mb: Mouse Button / Mw: Mouse Wheel