Added NerD 80% (TKL) support

[qmk_firmware.git] / keyboard / nerd / README.md

diff --git a/keyboard/nerd/README.md b/keyboard/nerd/README.md
index 0130fe49fd5b21ebfaf777f12cf39889923e5703..5b4acd3ba93ba3dd79a2d654b35a9088c3a5557a 100644 (file)
--- a/keyboard/nerd/README.md
+++ b/keyboard/nerd/README.md
@@ -17,6 +17,7 @@ Supported features
 
 * All layout options are supported
 * All leds are supported
+* 60% and 80% (TKL) pcbs are supported
 
 
 Changing Bootloader
@@ -35,7 +36,13 @@ won't work anymore and you'll lose your warrenty. GON won't provide any support
 Build
 -----
 
-Move to this directory then just run `make`.
+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