[Keyboard] GH60 Configurator updates and modernization (#6232)

[qmk_firmware.git] / keyboards / gh60 / readme.md

diff --git a/keyboards/gh60/readme.md b/keyboards/gh60/readme.md
index 92302d507ccb4d22d9e70b17bc4bc9104fe162ea..b63cce9735e3c7d65994d8c4125266e9160f4895 100644 (file)
--- a/keyboards/gh60/readme.md
+++ b/keyboards/gh60/readme.md
@@ -1,60 +1,52 @@
-## 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 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. \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
+GH60
+===
+
+![gh60 Rev C PCB](https://i.imgur.com/FejpoNF.jpg)
+
+A common 60% PCB.
+
+Keyboard Maintainer: QMK Community  
+Hardware Supported: GH60 rev. B and rev. C  
+Hardware Availability: http://blog.komar.be/projects/gh60-programmable-keyboard/
+
+Make example for this keyboard (after setting up your build environment):
+
+    make gh60:default
+
+See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
+
+
+## GH60 Hardware Information
+
+    /* 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()