diff options
Diffstat (limited to 'keyboards/gray_studio/hb85/readme.md')
-rw-r--r-- | keyboards/gray_studio/hb85/readme.md | 60 |
1 files changed, 60 insertions, 0 deletions
diff --git a/keyboards/gray_studio/hb85/readme.md b/keyboards/gray_studio/hb85/readme.md new file mode 100644 index 000000000..4e93607df --- /dev/null +++ b/keyboards/gray_studio/hb85/readme.md | |||
@@ -0,0 +1,60 @@ | |||
1 | # Gray Studio HB85 | ||
2 | |||
3 |  | ||
4 | |||
5 | A HitBit MSX Computer inspired Keyboard. | ||
6 | |||
7 | Keyboard Maintainer: [Felipe Coury](https://github.com/fcoury) | ||
8 | Hardware Supported: Gray Studio HB85 | ||
9 | Hardware Availability: Group buy finished | ||
10 | |||
11 | Make example for this keyboard (after setting up your build environment): | ||
12 | |||
13 | make hb85:default | ||
14 | |||
15 | See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. | ||
16 | |||
17 | |||
18 | ps2avrGB keyboard firmware | ||
19 | ========================== | ||
20 | |||
21 | This keyboard uses the port of the QMK firmware for boards that are based on the | ||
22 | ps2avrGB firmware. | ||
23 | |||
24 | Note that this is a complete replacement for the firmware, so you won't be | ||
25 | using Bootmapper Client to change any keyboard settings, since not all the | ||
26 | USB report options are supported. | ||
27 | |||
28 | ## Installing | ||
29 | |||
30 | First, install the requirements. These commands are for OSX, but all you | ||
31 | need is the AVR toolchain and `bootloadHID` for flashing: | ||
32 | |||
33 | ``` | ||
34 | $ brew cask install crosspack-avr | ||
35 | $ brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb | ||
36 | $ pip install pyusb | ||
37 | ``` | ||
38 | |||
39 | Then, with the keyboard plugged in, simply run this command from the | ||
40 | `qmk_firmware` directory: | ||
41 | |||
42 | ``` | ||
43 | $ make hb85 | ||
44 | $ bootloadHID -r hb85_default.hex | ||
45 | ``` | ||
46 | |||
47 | ## Setting the board to bootloader mode | ||
48 | |||
49 | Hold the F3 key while plugging the USB cable. | ||
50 | |||
51 | ## Troubleshooting | ||
52 | |||
53 | From my experience, it's really hard to brick these boards. But these | ||
54 | tricks have been useful when it got stuck in a weird scenario. | ||
55 | |||
56 | 1. Try plugging the board in while holding the bootloader key. This will force | ||
57 | it to boot only the bootloader without loading the firmware. Once this is | ||
58 | done, just reflash the board with the original firmware. | ||
59 | 2. Sometimes USB hubs can act weird, so try connecting the board directly | ||
60 | to your computer or plugging/unplugging the USB hub. | ||