[Keyboard] Add QMK configurator JSON for Alice PCB (#6397)

[qmk_firmware.git] / keyboards / handwired / kbod / readme.md

diff --git a/keyboards/handwired/kbod/readme.md b/keyboards/handwired/kbod/readme.md
index bd58fdd38426275cf0fb733d4be1473f6d29a828..470ccce0e3d6995e3d07faae4c6d2dbc2c89e2c1 100644 (file)
--- a/keyboards/handwired/kbod/readme.md
+++ b/keyboards/handwired/kbod/readme.md
@@ -1,19 +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
-```
\ No newline at end of file
+    avrdude -p m32u4 -c avr109 -P <COM PORT> -C <avrdude conf file> -e -u flash:w:handwired_kbod_default.hex
+
+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).