keychron_qmk_firmware/keyboards/gonnerd
Jack Humbert b476d65b9c Update keyboards' rules.mk/Makefiles (#1442)
this may change some of the keyboards' default settings - if you experience anything odd, please check back to this commit
2017-06-30 16:09:52 -04:00
..
keymaps define missing KC_NO macro 2017-02-13 13:44:53 +01:00
config.h add GON NerD 2017-02-11 17:14:40 +01:00
gonnerd.c add GON NerD 2017-02-11 17:14:40 +01:00
gonnerd.h add GON NerD 2017-02-11 17:14:40 +01:00
Makefile add GON NerD 2017-02-11 17:14:40 +01:00
readme.md adds documentation for reset button and adds one to the default keymap 2017-02-13 09:03:43 +01:00
rules.mk Update keyboards' rules.mk/Makefiles (#1442) 2017-06-30 16:09:52 -04:00

GON NerD keyboard firmware

Changing Bootloader

It's not possible to simply flash this firmware on the GON NerD keyboard as the original bootloader does not support DFU connections.

It is possible to change the bootloader of the GON NerD with an ISP programmer. A guide on how to change the bootloader on your GON NerD can be found here: Converting NerD60 to TMK. After changing the bootloader you can flash your QMK keymap onto the keyboard.

After changing the bootloader on your GON NerD PCB you will not be able to go back to the original firmware and the official configuration software will not work anymore. You will lose your warranty and official support from GON!

Reset button

To 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.

Building

Download 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.

Depending on which keymap you would like to use, you will have to compile slightly differently.

Default

To build with the default keymap, simply run make default.

Other Keymaps

Several 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.

To build the firmware binary hex file with a keymap just do make with a keymap like this:

$ make [default|jack|<name>]

Keymaps follow the format <name>.c and are stored in the keymaps folder.