qwerty_code_friendly: configurable left thumb

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

diff --git a/keyboards/gonnerd/readme.md b/keyboards/gonnerd/readme.md
index 1224ff6b0a943f274d0b05e651482a6d151298fb..26e4890d9453772e558e1b5b3ac41a44adc65dc5 100644 (file)
--- a/keyboards/gonnerd/readme.md
+++ b/keyboards/gonnerd/readme.md
@@ -1,5 +1,17 @@
-GON NerD keyboard firmware
-======================
+GON NerD
+========
+
+A Korean Custom TKL.
+
+Keyboard Maintainer: QMK Community
+Hardware Supported: GON NerD TKL PCB
+Hardware Availability: http://www.gonskeyboardworks.com/pcbs-and-controllers/60-nerd-tkl-ver20-pcb.html
+
+Make example for this keyboard (after setting up your build environment):
+
+    make gonnerd:default
+
+See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information.
 
 ## Changing Bootloader
 
@@ -11,24 +23,6 @@ It is possible to change the bootloader of the GON NerD with an ISP programmer.
 _After changing the bootloader on your GON NerD PCB you will not be able to go back to the original firmware and the official configuration software will
 not work anymore. You will lose your warranty and official support from GON!_
 
-## Building
-
-Download or clone the whole firmware and navigate to the keyboards/gonnerd 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 default`.
-
-### 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 a folder with the name of your keymap in the keymaps folder, and see keymap documentation (you can find in top readme.md) and existant keymap files.
-
-To build the firmware binary hex file with a keymap just do `make` with a keymap like this:
-
-```
-$ make [default|jack|<name>]
-```
+## Reset button
 
-Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.
+To run the `make dfu` command to flash keymaps onto the board, you need to put the board into DFU mode. As the GON NerD PCBs do not have a reset button on the board to put it into DFU mode, be sure to include a `RESET` button on your keymap. Otherwise you'll have to unscrew your keyboard from the case and short the GND and RST pins.