summaryrefslogtreecommitdiffstats
path: root/keyboards/donutcables/budget96/readme.md
diff options
context:
space:
mode:
authorMechMerlin <30334081+mechmerlin@users.noreply.github.com>2019-04-04 14:25:35 -0700
committerDrashna Jaelre <drashna@live.com>2019-04-04 14:25:35 -0700
commitf698f1e3f4f51431473d54512fd6c0609b9b72ee (patch)
treee8ff0918d913d863322da63ef9157a978d1dcbc9 /keyboards/donutcables/budget96/readme.md
parent852d125413388aa3e71d2be91f04ddea534f2af3 (diff)
[Keyboard] Add Budget96 by Donut Cables (#5550)
* initial commit of budget96 * non logic changes * add my name to readme * update matrix.c * make the matrix representation of the layout macro * fix up LAYOUT macro * add missing character * initial keymap commit * put KC_NO where they belong * basic keymap * fix matrix row and col definition * The diagram I was sent and the pins used I was sent were in opposite order from each other. This should fix the issues * update the readme * change up manufacturer for budget96 * update copyright date * fix up the switch matrix and provide a keymap * forgot the keymap * other matrix fixes * missing a few keys in the switch matrix * messed up the row tracing * tweak keymap a bit * use a lower case k * fix spacing for markdown rendering * put in the reset key documentation * clean up the file a little * use LAYOUT_96_ansi * add a second layer for lighting controls * add in lighting support * add QMK Configurator support * use pragma once * remove un needed matrix.c * convert to GPIO methods * turn on rgblight_enable and get rid of custom matrix * set bootloadhid_bootloader to 1 * set bootmagic to lite and set it to k50 * add reset information to readme * use i2c_master instead of custom i2c * restore the custom i2c code * introduce reset key and eep_rst in function layer 1 * fix up pip3 install commands * fix up device and manufacturer names * remove un needed comments * add an ALL layout macro along with QMK Configurator support * move budget96 into donutcables directory since he actually has different boards * add a short donut cables blurb taken from his website * update readme for make instructions to point to the new path * Update keyboards/donutcables/budget96/config.h Co-Authored-By: mechmerlin <30334081+mechmerlin@users.noreply.github.com> * Update keyboards/donutcables/budget96/readme.md Co-Authored-By: mechmerlin <30334081+mechmerlin@users.noreply.github.com> * Update keyboards/donutcables/budget96/info.json Co-Authored-By: mechmerlin <30334081+mechmerlin@users.noreply.github.com> * turn on backlight * Update keyboards/donutcables/budget96/readme.md Co-Authored-By: mechmerlin <30334081+mechmerlin@users.noreply.github.com> * remove extra UART and BOOTLOADER settings that are not needed
Diffstat (limited to 'keyboards/donutcables/budget96/readme.md')
-rw-r--r--keyboards/donutcables/budget96/readme.md44
1 files changed, 44 insertions, 0 deletions
diff --git a/keyboards/donutcables/budget96/readme.md b/keyboards/donutcables/budget96/readme.md
new file mode 100644
index 0000000000..e44b9a3e72
--- /dev/null
+++ b/keyboards/donutcables/budget96/readme.md
@@ -0,0 +1,44 @@
+# budget96
+
+96 key atmega32a keyboard.
+
+Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)
+Hardware Supported: Budget96 PCB
+Hardware Availability: [DonutCables](https://donutcables.com/)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make donutcables/budget96:default
+
+Flashing
+
+**Reset Key:** Hold down the key located at `K00`, commonly programmed as left control while plugging in the keyboard. You may also hold down the key located at `K50`, commonly programmed as the `Esc` key.
+
+ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods.
+
+Windows:
+1. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
+2. Place your keyboard into reset.
+3. Press the `Find Device` button and ensure that your keyboard is found.
+4. Press the `Open .hex File` button and locate the `.hex` file you created.
+5. Press the `Flash Device` button and wait for the process to complete.
+
+macOS:
+1. Install homebrew by typing the following:
+ ```
+ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
+ ```
+2. Install `crosspack-avr`.
+ ```
+ brew cask install crosspack-avr
+ ```
+3. Install the following packages:
+ ```
+ brew install python
+ pip3 install pyusb
+ brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
+
+4. Place your keyboard into reset.
+5. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` 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).