aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/gon/nerdtkl/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/gon/nerdtkl/readme.md')
-rw-r--r--keyboards/gon/nerdtkl/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/gon/nerdtkl/readme.md b/keyboards/gon/nerdtkl/readme.md
new file mode 100644
index 000000000..f8e982e77
--- /dev/null
+++ b/keyboards/gon/nerdtkl/readme.md
@@ -0,0 +1,27 @@
+# GON NerD TKL
+
+A Korean Custom TKL.
+
+* Keyboard Maintainer: QMK Community
+* Hardware Supported: GON NerD TKL PCB
+* Hardware Availability: [gonskeyboardworks.com](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 gon/nerdtkl: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).
+
+## Changing Bootloader
+
+It's not possible to simply flash this firmware on the GON NerD keyboard as the original bootloader does not support DFU connections.
+
+It is possible to change the bootloader of the GON NerD with an ISP programmer. A guide on how to change the bootloader on your GON NerD can be found here:
+[Converting NerD60 to TMK](https://deskthority.net/wiki/Converting_NerD60_to_TMK). After changing the bootloader you can flash your QMK keymap onto the keyboard.
+
+_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!_
+
+## Reset button
+
+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.