aboutsummaryrefslogtreecommitdiff
path: root/keyboards/gonnerd/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/gonnerd/readme.md')
-rw-r--r--keyboards/gonnerd/readme.md38
1 files changed, 14 insertions, 24 deletions
diff --git a/keyboards/gonnerd/readme.md b/keyboards/gonnerd/readme.md
index 807df308a..388816abb 100644
--- a/keyboards/gonnerd/readme.md
+++ b/keyboards/gonnerd/readme.md
@@ -1,5 +1,17 @@
1GON NerD keyboard firmware 1GON NerD
2====================== 2========
3
4A Korean Custom TKL.
5
6Keyboard Maintainer: QMK Community
7Hardware Supported: GON NerD TKL PCB
8Hardware Availability: http://www.gonskeyboardworks.com/pcbs-and-controllers/60-nerd-tkl-ver20-pcb.html
9
10Make example for this keyboard (after setting up your build environment):
11
12 make gonnerd-default
13
14See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information.
3 15
4## Changing Bootloader 16## Changing Bootloader
5 17
@@ -14,25 +26,3 @@ not work anymore. You will lose your warranty and official support from GON!_
14## Reset button 26## Reset button
15 27
16To 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. 28To 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.
17
18## Building
19
20Download or clone the whole firmware and navigate to the keyboards/gonnerd folder. Once your dev env is setup, you'll be able to type `make` to generate your .hex - you can then use the Teensy Loader to program your .hex file.
21
22Depending on which keymap you would like to use, you will have to compile slightly differently.
23
24### Default
25
26To build with the default keymap, simply run `make default`.
27
28### Other Keymaps
29
30Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create a folder with the name of your keymap in the keymaps folder, and see keymap documentation (you can find in top readme.md) and existant keymap files.
31
32To build the firmware binary hex file with a keymap just do `make` with a keymap like this:
33
34```
35$ make [default|jack|<name>]
36```
37
38Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.