summaryrefslogtreecommitdiff
path: root/keyboard/nerd/README.md
blob: 5b4acd3ba93ba3dd79a2d654b35a9088c3a5557a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
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.