keyboards/gh60/readme.md

   1 ## gh60 Rev C keyboard firmware
   2
   3 ![gh60 Rev C PCB](gh60revc.jpg)
   4
   5     /* Column pin configuration
   6     * col: 0   1   2   3   4   5   6   7   8   9   10  11  12  13
   7     * pin: F0  F1  E6  C7  C6  B6  D4  B1  B7  B5  B4  D7  D6  B3  (Rev.C)
   8     */
   9
  10     /* Row pin configuration
  11     * row: 0   1   2   3   4
  12     * pin: D0  D1  D2  D3  D5
  13     */
  14
  15     GPIO pads
  16     0 F7 WASD LEDs
  17     1 F6 ESC LED
  18     2 F5 FN LED
  19     3 F4 POKER Arrow LEDs
  20
  21     B2 Capslock LED
  22     B0 not connected
  23
  24 Functions to controls LED clusters
  25
  26     gh60_caps_led_on()
  27     gh60_poker_leds_on()
  28     gh60_fn_led_on()
  29     gh60_esc_led_on()
  30     gh60_wasd_leds_on()
  31
  32     gh60_caps_led_off()
  33     gh60_poker_leds_off()
  34     gh60_fn_led_off()
  35     gh60_esc_led_off()
  36     gh60_wasd_leds_off()
  37
  38 ======================
  39
  40 ## Quantum MK Firmware
  41
  42 For the full Quantum feature list, see [the parent readme.md](/readme.md).
  43
  44 ## Building
  45
  46 Download or clone the whole firmware and navigate to the keyboards/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.
  47
  48 Depending on which keymap you would like to use, you will have to compile slightly differently.
  49
  50 ### Default
  51 To build with the default keymap, simply run `make default`.
  52
  53 ### Other Keymaps
  54 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.
  55
  56 To build the firmware binary hex file with a keymap just do `make` with a keymap like this:
  57
  58 ```
  59 $ make [default|jack|<name>]
  60 ```
  61
  62 Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.