diff options
author | noroadsleft <18669334+noroadsleft@users.noreply.github.com> | 2018-12-12 16:46:13 -0800 |
---|---|---|
committer | Drashna Jaelre <drashna@live.com> | 2018-12-12 16:46:13 -0800 |
commit | ca39fa8222ed339f09b2713bd538880fd4f2ff0e (patch) | |
tree | fd32cb42b36f0234f7cd8b596a0da5cad282ebe3 /keyboards/handwired/kbod/readme.md | |
parent | 2cef75cbb3ba9a3c05cf6914c6bafb720f2f2b83 (diff) |
Keyboard: handwired/kbod Refactor, Configurator support and readme update (#4623)
* handwired/kbod: refactor
- layout macro KEYMAP renamed to LAYOUT
* handwired/kbod: update config.h files to #pragma once
* handwired/kbod: Configurator support
* handwired/kbod: readme update
- updated reademe to current template
- added image
Diffstat (limited to 'keyboards/handwired/kbod/readme.md')
-rw-r--r-- | keyboards/handwired/kbod/readme.md | 23 |
1 files changed, 10 insertions, 13 deletions
diff --git a/keyboards/handwired/kbod/readme.md b/keyboards/handwired/kbod/readme.md index d2f2c01ae8..470ccce0e3 100644 --- a/keyboards/handwired/kbod/readme.md +++ b/keyboards/handwired/kbod/readme.md @@ -1,21 +1,18 @@ -KBOD keyboard firmware -====================== +# KBOD -KBOD is a 60% Keyboard kit, hand-wired, with Arduino Micro as its controller. It's utilize 8x8 matrix and has layout similar to GH-60 +![KBOD](https://f4.fudanchii.net/shx/2017/02/IMG_20170212_224547.jpg) -## Quantum MK Firmware +KBOD is a 60% Keyboard kit, hand-wired, with Arduino Micro as its controller. It utilizes an 8x8 matrix and has layout similar to GH60. [More info](https://github.com/fudanchii/keyboard_of_disapproval) -For the full Quantum feature list, see [the parent readme](/). +Keyboard Maintainer: [The QMK Community](https://github.com/qmk) +Hardware Supported: Arduino Micro -## Building +Make example for this keyboard (after setting up your build environment): -Download or clone the whole firmware and use ```make handwired/kbod:default``` to generate the .hex file. You may flash it with avrdude + make handwired/kbod:default -## Flashing -Something along this line: +Flashing your firmware may be done with avrdude. The command should be something along this line: -``` -avrdude -p m32u4 -c avr109 -P <COM PORT> -C <avrdude conf file> -e -u flash:w:handwired_kbod_default.hex -``` + avrdude -p m32u4 -c avr109 -P <COM PORT> -C <avrdude conf file> -e -u flash:w:handwired_kbod_default.hex -[More info](https://github.com/fudanchii/keyboard_of_disapproval)
\ No newline at end of file +See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). |