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.
This repo is archived. You can view files and clone it, but cannot push or open issues/pull-requests.

README.md 5.6KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110
  1. KMAC keyboard firmware
  2. ======================
  3. Korean custom keyboard designed by Byungho Kim and KBDMania community.
  4. *Note that this is not the official firmware*
  5. Supported models
  6. ----------------
  7. At the moment only the TKL models is supported.
  8. Build
  9. -----
  10. Move to this directory then just run `make` like:
  11. $ make -f Makefile.[pjrc|lufa] [winkey|winkeyless]
  12. Use `Makefile.pjrc` if you want to use PJRC stack or use `Makefile.lufa` for LUFA stack.
  13. Bootloader
  14. ---------
  15. The PCB is hardwired to run the bootloader if the key at the `Caps Lock` position is held down when connecting the keyboard.
  16. It is still possible to use Boot Magic and Command to access the bootloader though.
  17. Keymap
  18. ------
  19. There are 2 different types of PCB.
  20. They each have their own keymap file.
  21. To customize a keymap:
  22. 1. Edit the file that corresponds to your PCB.
  23. 2. Specify your layout when building.
  24. ### 1. Winkey
  25. This is the default keymap.
  26. See [keymap_winkey.h](keymap_winkey.h) for detail.
  27. #### 1.0. Winkey Default Layer
  28. ,---. ,---------------. ,---------------. ,---------------. ,-----------.
  29. |Esc| |F1 |F2 |F3 |F4 | |F5 |F6 |F7 |F8 | |F9 |F10|F11|F12| |PrS|ScL|Pau|
  30. `---' `---------------' `---------------' `---------------' `-----------'
  31. ,-----------------------------------------------------------. ,-----------.
  32. |~ | 1| 2| 3| 4| 5| 6| 7| 8| 9| 0| -| =|Backsp | |Ins|Hom|PgU|
  33. |-----------------------------------------------------------| |-----------|
  34. |Tab | Q| W| E| R| T| Y| U| I| O| P| [| ]| \| |Del|End|PgD|
  35. |-----------------------------------------------------------| '-----------'
  36. |Fn0 | A| S| D| F| G| H| J| K| L| ;| '|Return |
  37. |-----------------------------------------------------------| ,---.
  38. |Shift | Z| X| C| V| B| N| M| ,| .| /|Shift | |Up |
  39. |-----------------------------------------------------------| ,-----------.
  40. |Ctl|Gui|Alt| Space |Alt|Gui|App|Ctl| |Lef|Dow|Rig|
  41. `-----------------------------------------------------------' `-----------'
  42. #### 1.1. Winkey Media Layer
  43. ,---. ,---------------. ,---------------. ,---------------. ,-----------.
  44. |Led| | | | | | | | | | | | | | | | | | |Slp|
  45. `---' `---------------' `---------------' `---------------' `-----------'
  46. ,-----------------------------------------------------------. ,-----------.
  47. | | | | | | | | | | |Mut|V- |V+ | | | | | |
  48. |-----------------------------------------------------------| |-----------|
  49. | | | | | | | | | |Stp|Ply|Prv|Nxt|Media| | | | |
  50. |-----------------------------------------------------------| '-----------'
  51. | | | | | | | | | | | | | |
  52. |-----------------------------------------------------------| ,---.
  53. | | | |Clc| | | | | | | |Caps | | |
  54. |-----------------------------------------------------------| ,-----------.
  55. | | | | | | | | | | | | |
  56. `-----------------------------------------------------------' `-----------'
  57. ### 2. Winkeyless
  58. Layout with 1.5 unit modifiers.
  59. See [keymap_winkeyless.h](keymap_winkeyless.h) for detail.
  60. #### 2.0. Winkeyless Default Layer
  61. ,---. ,---------------. ,---------------. ,---------------. ,-----------.
  62. |Esc| |F1 |F2 |F3 |F4 | |F5 |F6 |F7 |F8 | |F9 |F10|F11|F12| |PrS|ScL|Pau|
  63. `---' `---------------' `---------------' `---------------' `-----------'
  64. ,-----------------------------------------------------------. ,-----------.
  65. |~ | 1| 2| 3| 4| 5| 6| 7| 8| 9| 0| -| =|Backsp | |Ins|Hom|PgU|
  66. |-----------------------------------------------------------| |-----------|
  67. |Tab | Q| W| E| R| T| Y| U| I| O| P| [| ]| \| |Del|End|PgD|
  68. |-----------------------------------------------------------| '-----------'
  69. |Fn0 | A| S| D| F| G| H| J| K| L| ;| '|Return |
  70. |-----------------------------------------------------------| ,---.
  71. |Shift | Z| X| C| V| B| N| M| ,| .| /|Shift | |Up |
  72. |-----------------------------------------------------------| ,-----------.
  73. |Ctl |Gui|Alt | Space |Alt |Gui|Ctl | |Lef|Dow|Rig|
  74. `-----------------------------------------------------------' `-----------'
  75. #### 2.1. Winkeyless Media Layer
  76. ,---. ,---------------. ,---------------. ,---------------. ,-----------.
  77. |Led| | | | | | | | | | | | | | | | | | |Slp|
  78. `---' `---------------' `---------------' `---------------' `-----------'
  79. ,-----------------------------------------------------------. ,-----------.
  80. | | | | | | | | | | |Mut|V- |V+ | | | | | |
  81. |-----------------------------------------------------------| |-----------|
  82. | | | | | | | | | |Stp|Ply|Prv|Nxt|Media| | | | |
  83. |-----------------------------------------------------------| '-----------'
  84. | | | | | | | | | | | | | |
  85. |-----------------------------------------------------------| ,---.
  86. | | | |Clc| | | | | | | |Caps | | |
  87. |-----------------------------------------------------------| ,-----------.
  88. | | | | | | | | | | | |
  89. `-----------------------------------------------------------' `-----------'