Merge remote-tracking branch 'upstream/master'

1 files changed, 52 insertions, 0 deletions

diff --git a/keyboard/nerd/README.md b/keyboard/nerd/README.md
new file mode 100644
index 0000000000..5b4acd3ba9
--- /dev/null
+++ b/keyboard/nerd/README.md
@@ -0,0 +1,52 @@
+NerD keyboard firmware
+========================
+
+Korean Keyboard designed by GON.
+
+*Note that this is not the official firmware*
+
+
+Hardware revision
+-----------------
+
+This firmware was developed and tested for NerD pcb version 1.61 and 2.0.
+
+
+Supported features
+------------------
+
+* All layout options are supported
+* All leds are supported
+* 60% and 80% (TKL) pcbs are supported
+
+
+Changing Bootloader
+-------------------
+
+You can't simply just upload this firmware to a new NerD board because the original
+bootloader won't accept DFU connections.
+
+You can change the bootloader of the keyboard with an ISP programmer of your choice.
+The bootloader pins are easy to access on the NerD pcb.
+
+*Be aware that after changing the bootloader the official configuration software
+won't work anymore and you'll lose your warrenty. GON won't provide any support for this firmware.*
+
+
+Build
+-----
+
+For building you have to specify two build-options, LAYOUT and KEYMAP. The layout option defines
+pcb layout and can be either 60% or 80% at the momemnt. The keymap option selects your
+preferred keymapping.
+
+Move to this directory then just run `make LAYOUT=60 KEYMAP=ansi150`
+
+to compile a firmware for a 60% pcb with ANSI 150 key mapping.
+
+
+Jump to Bootloader
+------------------
+
+You can jump to bootloader by software if you have a macro defined for this in your keymap. The
+default command is (LSFT+RSFT+PAUS) to access the bootloader by software jump.