diff options
| author | Nurahmadie <nurahmadie@gmail.com> | 2017-02-26 11:41:03 +0700 |
|---|---|---|
| committer | Nurahmadie <nurahmadie@gmail.com> | 2017-04-02 18:27:28 +0700 |
| commit | 10105f645a7fdcf0d636e0eb2c768754521602a3 (patch) | |
| tree | 1ff749a7b2d079ba30865938c71fd60007acaa9e /keyboards/handwired/kbod | |
| parent | c9dd11d5abec11aa046031c12b1aa5edc5efae77 (diff) | |
| download | qmk_firmware-10105f645a7fdcf0d636e0eb2c768754521602a3.tar.gz qmk_firmware-10105f645a7fdcf0d636e0eb2c768754521602a3.zip | |
Add README
Diffstat (limited to 'keyboards/handwired/kbod')
| -rw-r--r-- | keyboards/handwired/kbod/keymaps/default/readme.md | 6 | ||||
| -rw-r--r-- | keyboards/handwired/kbod/readme.md | 25 |
2 files changed, 13 insertions, 18 deletions
diff --git a/keyboards/handwired/kbod/keymaps/default/readme.md b/keyboards/handwired/kbod/keymaps/default/readme.md index 3fe84c6194..35c22ec007 100644 --- a/keyboards/handwired/kbod/keymaps/default/readme.md +++ b/keyboards/handwired/kbod/keymaps/default/readme.md @@ -1 +1,5 @@ -# The default keymap for kbod
\ No newline at end of file +# The default keymap for kbod + +This is the default keymap for kbod, + +it consists of a base layer with QWERTY layout, a momentary cursor-layer, and mouse-keys and multimedia layers.
\ No newline at end of file diff --git a/keyboards/handwired/kbod/readme.md b/keyboards/handwired/kbod/readme.md index 179ab1d792..bd58fdd384 100644 --- a/keyboards/handwired/kbod/readme.md +++ b/keyboards/handwired/kbod/readme.md @@ -1,28 +1,19 @@ -kbod keyboard firmware +KBOD keyboard firmware ====================== +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 + ## Quantum MK Firmware For the full Quantum feature list, see [the parent readme](/). ## Building -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. - -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`. +Download or clone the whole firmware and use ```make handwired-kbod-default``` to generate the .hex file. You may flash it with avrdude -### 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: +## Flashing +Something along this line: ``` -$ make [default|jack|<name>] -``` - -Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder. +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 |