]> git.donarmstrong.com Git - qmk_firmware.git/blobdiff - keyboard/gh60/README.md
adds backlight levels to the satan keyboard (#431)
[qmk_firmware.git] / keyboard / gh60 / README.md
index 289467aba792e9674e3bf02fb2ca06e4a8444fef..bf209be8c6a04b2ff4066694d5566e530d66f83f 100644 (file)
-GH60 keyboard firmware
-======================
-DIY compact keyboard designed and run by komar007 and Geekhack community.
-
-## Threads on Geekhack.org
-- [Prototyping](http://geekhack.org/index.php?topic=34959.0)
-- [Beta-test](http://geekhack.org/index.php?topic=37570.0)
-
-
-## Build
-Move to this directory then just run `make` like:
-
-   $ make -f Makfile.[pjrc|lufa]
-
-
-## Boot Magic
-- `Fn` key for bootloader kick up.
-- `D` key for Debug enable.
-
-
-## Keymap
-Two version of keymap are available. `Plan` and `Funky`.
-See keymap.c to define your own favourite keymap.
-
-### 1. Plain keymap
-This will be useful if you want to use key mapping tool like AHK.
-To get this plain keymap do `make`:
-
-    $ make -f Makefile.[pjrc|lufa] plain
-
-### Layer 0
-    ,-----------------------------------------------------------.
-    |Esc|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backsp |
-    |-----------------------------------------------------------|
-    |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|    \|
-    |-----------------------------------------------------------|
-    |Caps  |  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Return  |
-    |-----------------------------------------------------------|
-    |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  .|  /|Shift     |
-    |-----------------------------------------------------------|
-    |Ctrl|Gui |Alt |      Space             |Alt |Gui |App |Ctrl|
-    `-----------------------------------------------------------'
-
-
-### 2. Funky layers.
-
-    $ make -f Makefile.[pjrc|lufa]
-
-#### Layer 0: Default Layer
-    ,-----------------------------------------------------------.
-    |Esc|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backsp |
-    |-----------------------------------------------------------|
-    |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|    \|
-    |-----------------------------------------------------------|
-    |Caps  |  A|  S|  D|  F|  G|  H|  J|  K|  L|*L3|  '|Return  |
-    |-----------------------------------------------------------|
-    |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  .|*L2|Shift     |
-    |-----------------------------------------------------------|
-    |Ctrl|Gui |Alt |      Space             |Alt |*L3 |*L3 |*L1 |
-    `-----------------------------------------------------------'
-
-#### Layer 1: HHKB mode
-    ,-----------------------------------------------------------.
-    |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Delete |
-    |-----------------------------------------------------------|
-    |Caps |   |   |   |   |   |   |   |Psc|Slk|Pus|Up |   |Inser|
-    |-----------------------------------------------------------|
-    |Contro|VoD|VoU|Mut|   |   |  *|  /|Hom|PgU|Lef|Rig|Enter   |
-    |-----------------------------------------------------------|
-    |Shift   |   |   |   |   |   |  +|  -|End|PgD|Dow|Shift     |
-    |-----------------------------------------------------------|
-    |Ctrl|Gui |Alt |      Space             |Alt |Gui |App |*L0 |
-    `-----------------------------------------------------------'
-
-#### Layer 2: Vi mode
-    ,-----------------------------------------------------------.
-    |  `| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Backsp |
-    |-----------------------------------------------------------|
-    |Tab  |Hom|PgD|Up |PgU|End|Hom|PgD|PgU|End|   |   |   |     |
-    |-----------------------------------------------------------|
-    |Contro|   |Lef|Dow|Rig|   |Lef|Dow|Up |Rig|   |   |Return  |
-    |-----------------------------------------------------------|
-    |Shift   |   |   |   |   |   |Hom|PgD|PgU|End|*L0|Shift     |
-    |-----------------------------------------------------------|
-    |Ctrl|Gui |Alt |      Space             |Alt |Gui |App |Ctrl|
-    `-----------------------------------------------------------'
-
-#### Layer 3: Mouse mode
-    ,-----------------------------------------------------------.
-    |  `| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Backsp |
-    |-----------------------------------------------------------|
-    |Tab  |MwL|MwD|McU|MwU|MwR|MwL|MwD|MwU|MwR|   |   |   |     |
-    |-----------------------------------------------------------|
-    |Contro|   |McL|McD|McR|   |McL|McD|McU|McR|*L0|   |Return  |
-    |-----------------------------------------------------------|
-    |Shift   |   |   |Mb1|Mb2|Mb3|Mb2|Mb1|   |   |   |Shift     |
-    |-----------------------------------------------------------|
-    |Ctrl|Gui |Alt |      Space             |Alt |*L0 |*L0 |Ctrl|
-    `-----------------------------------------------------------'
-    Mc: Mouse Cursor / Mb: Mouse Button / Mw: Mouse Wheel 
-
+## gh60 Rev C keyboard firmware\r
+\r
+![gh60 Rev C PCB](gh60revc.jpg)\r
+\r
+    /* Column pin configuration\r
+    * col: 0   1   2   3   4   5   6   7   8   9   10  11  12  13\r
+    * pin: F0  F1  E6  C7  C6  B6  D4  B1  B7  B5  B4  D7  D6  B3  (Rev.C)\r
+    */\r
+     \r
+    /* Row pin configuration\r
+    * row: 0   1   2   3   4\r
+    * pin: D0  D1  D2  D3  D5\r
+    */\r
+     \r
+    GPIO pads\r
+    0 F7 WASD LEDs\r
+    1 F6 ESC LED\r
+    2 F5 FN LED\r
+    3 F4 POKER Arrow LEDs\r
+     \r
+    B2 Capslock LED\r
+    B0 not connected\r
+       \r
+Functions to controls LED clusters\r
+       \r
+    gh60_caps_led_on()\r
+    gh60_poker_leds_on()\r
+    gh60_fn_led_on()\r
+    gh60_esc_led_on()\r
+    gh60_wasd_leds_on()\r
+    \r
+    gh60_caps_led_off()\r
+    gh60_poker_leds_off()\r
+    gh60_fn_led_off()\r
+    gh60_esc_led_off()\r
+    gh60_wasd_leds_off()\r
+       \r
+======================\r
+\r
+## Quantum MK Firmware\r
+\r
+For the full Quantum feature list, see [the parent README.md](/README.md).\r
+\r
+## Building\r
+\r
+Download or clone the whole firmware and navigate to the keyboard/gh60_rev_c folder. Once your dev env is setup, you'll be able to type `make` to generate your .hex - you can then use the Teensy Loader to program your .hex file. \r
+\r
+Depending on which keymap you would like to use, you will have to compile slightly differently.\r
+\r
+### Default\r
+To build with the default keymap, simply run `make`.\r
+\r
+### Other Keymaps\r
+Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create file named `<name>.c` in the keymaps folder, and see keymap document (you can find in top README.md) and existent keymap files.\r
+\r
+To build the firmware binary hex file with a keymap just do `make` with `KEYMAP` option like:\r
+```\r
+$ make KEYMAP=[default|jack|<name>]\r
+```\r
+Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.\r