orphan/nerd/README.md

   1 NerD keyboard firmware
   2 ========================
   3
   4 Korean Keyboard designed by GON.
   5
   6 *Note that this is not the official firmware*
   7
   8
   9 Hardware revision
  10 -----------------
  11
  12 This firmware was developed and tested for NerD pcb version 1.61 and 2.0.
  13
  14
  15 Supported features
  16 ------------------
  17
  18 * All layout options are supported
  19 * All leds are supported
  20 * 60% and 80% (TKL) pcbs are supported
  21
  22
  23 Changing Bootloader
  24 -------------------
  25
  26 You can't simply just upload this firmware to a new NerD board because the original
  27 bootloader won't accept DFU connections.
  28
  29 You can change the bootloader of the keyboard with an ISP programmer of your choice.
  30 The bootloader pins are easy to access on the NerD pcb.
  31
  32 *Be aware that after changing the bootloader the official configuration software
  33 won't work anymore and you'll lose your warrenty. GON won't provide any support for this firmware.*
  34
  35
  36 Build
  37 -----
  38
  39 For building you have to specify two build-options, LAYOUT and KEYMAP. The layout option defines
  40 pcb layout and can be either 60% or 80% at the momemnt. The keymap option selects your
  41 preferred keymapping.
  42
  43 Move to this directory then just run `make LAYOUT=60 KEYMAP=ansi150`
  44
  45 to compile a firmware for a 60% pcb with ANSI 150 key mapping.
  46
  47
  48 Jump to Bootloader
  49 ------------------
  50
  51 You can jump to bootloader by software if you have a macro defined for this in your keymap. The
  52 default command is (LSFT+RSFT+PAUS) to access the bootloader by software jump.