Fixed default to dissable VIA (#5309)

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

diff --git a/keyboards/handwired/kbod/readme.md b/keyboards/handwired/kbod/readme.md
index 179ab1d7927631fb5ac28067e9175d64c5508c2b..470ccce0e3d6995e3d07faae4c6d2dbc2c89e2c1 100644 (file)
--- a/keyboards/handwired/kbod/readme.md
+++ b/keyboards/handwired/kbod/readme.md
@@ -1,28 +1,18 @@
-kbod keyboard firmware
-======================
+# KBOD
 
-## Quantum MK Firmware
+![KBOD](https://f4.fudanchii.net/shx/2017/02/IMG_20170212_224547.jpg)
 
-For the full Quantum feature list, see [the parent readme](/).
+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)
 
-## Building
+Keyboard Maintainer: [The QMK Community](https://github.com/qmk)  
+Hardware Supported: Arduino Micro  
 
-Download or clone the whole firmware and navigate to the keyboards/kbod 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. 
+Make example for this keyboard (after setting up your build environment):
 
-Depending on which keymap you would like to use, you will have to compile slightly differently.
+    make handwired/kbod:default
 
-### Default
+Flashing your firmware may be done with avrdude. The command should be something along this line:
 
-To build with the default keymap, simply run `make default`.
+    avrdude -p m32u4 -c avr109 -P <COM PORT> -C <avrdude conf file> -e -u flash:w:handwired_kbod_default.hex
 
-### 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.
+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).