Make the bulk of our keyboards match the readme.md standard
This commit is contained in:
parent
2ee0dc7793
commit
4e73b0b8d7
32 changed files with 355 additions and 1155 deletions
|
@ -1,5 +1,17 @@
|
|||
GON NerD keyboard firmware
|
||||
======================
|
||||
GON NerD
|
||||
========
|
||||
|
||||
A Korean Custom TKL.
|
||||
|
||||
Keyboard Maintainer: QMK Community
|
||||
Hardware Supported: GON NerD TKL PCB
|
||||
Hardware Availability: http://www.gonskeyboardworks.com/pcbs-and-controllers/60-nerd-tkl-ver20-pcb.html
|
||||
|
||||
Make example for this keyboard (after setting up your build environment):
|
||||
|
||||
make gonnerd-default
|
||||
|
||||
See [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.
|
||||
|
||||
## Changing Bootloader
|
||||
|
||||
|
@ -14,25 +26,3 @@ 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.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue