diff options
| author | Christopher Browne <cbbrowne@ca.afilias.info> | 2016-06-24 12:19:34 -0400 |
|---|---|---|
| committer | Christopher Browne <cbbrowne@ca.afilias.info> | 2016-06-24 12:19:34 -0400 |
| commit | 4d79e224384464c8b42c770b3da09b9655d359e7 (patch) | |
| tree | 7d14e742352d2237ab19fe49985bbacef47d7e6d /keyboards/gh60/readme.md | |
| parent | a4bdb0ac0e6d44c9c9a2d8910a5ca5b7fb49fcbf (diff) | |
| parent | 40bfc7231e87c883c840967fdbe42a7c711805be (diff) | |
Merge branch 'master' of https://github.com/jackhumbert/qmk_firmware
Diffstat (limited to 'keyboards/gh60/readme.md')
| -rw-r--r-- | keyboards/gh60/readme.md | 60 |
1 files changed, 60 insertions, 0 deletions
diff --git a/keyboards/gh60/readme.md b/keyboards/gh60/readme.md new file mode 100644 index 0000000000..92302d507c --- /dev/null +++ b/keyboards/gh60/readme.md @@ -0,0 +1,60 @@ +## gh60 Rev C keyboard firmware
+
+
+
+ /* Column pin configuration
+ * col: 0 1 2 3 4 5 6 7 8 9 10 11 12 13
+ * pin: F0 F1 E6 C7 C6 B6 D4 B1 B7 B5 B4 D7 D6 B3 (Rev.C)
+ */
+
+ /* Row pin configuration
+ * row: 0 1 2 3 4
+ * pin: D0 D1 D2 D3 D5
+ */
+
+ GPIO pads
+ 0 F7 WASD LEDs
+ 1 F6 ESC LED
+ 2 F5 FN LED
+ 3 F4 POKER Arrow LEDs
+
+ B2 Capslock LED
+ B0 not connected
+
+Functions to controls LED clusters
+
+ gh60_caps_led_on()
+ gh60_poker_leds_on()
+ gh60_fn_led_on()
+ gh60_esc_led_on()
+ gh60_wasd_leds_on()
+
+ gh60_caps_led_off()
+ gh60_poker_leds_off()
+ gh60_fn_led_off()
+ gh60_esc_led_off()
+ gh60_wasd_leds_off()
+
+======================
+
+## Quantum MK Firmware
+
+For the full Quantum feature list, see [the parent readme.md](/readme.md).
+
+## Building
+
+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.
+
+Depending on which keymap you would like to use, you will have to compile slightly differently.
+
+### Default
+To build with the default keymap, simply run `make`.
+
+### Other Keymaps
+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.
+
+To build the firmware binary hex file with a keymap just do `make` with `KEYMAP` option like:
+```
+$ make KEYMAP=[default|jack|<name>]
+```
+Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.
|