diff options
author | MechMerlin <30334081+mechmerlin@users.noreply.github.com> | 2019-02-18 17:35:34 +0100 |
---|---|---|
committer | Drashna Jaelre <drashna@live.com> | 2019-02-18 17:35:34 +0100 |
commit | f0edc993b7beb15cc9c0443677801daddcae710b (patch) | |
tree | 0d0ee27fca9ea4384a905cdc26878aaa796ee18d /keyboards/winkeyless/bface/README.md | |
parent | 593d08d6aec38aca6f38db4a17f3d8cdcd13bf28 (diff) | |
download | qmk_firmware-f0edc993b7beb15cc9c0443677801daddcae710b.tar.gz qmk_firmware-f0edc993b7beb15cc9c0443677801daddcae710b.tar.xz |
[Keyboard] Winkeyless Directory (#5163)
* introduce wkl directory and readme
* move bface into winkeyless directory and edit readme for new make instructions
* move bmini into the winkeyless directory and edit readme
* move bmini ex into winkeyless directory
* edit readme some more
* add newbs guide to readmes
* fix path to bface
* temporarily turn off community layout support until we refactor this taking out all the custom ps2avrgb stuff
Diffstat (limited to 'keyboards/winkeyless/bface/README.md')
-rw-r--r-- | keyboards/winkeyless/bface/README.md | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/keyboards/winkeyless/bface/README.md b/keyboards/winkeyless/bface/README.md new file mode 100644 index 000000000..f1789b04c --- /dev/null +++ b/keyboards/winkeyless/bface/README.md @@ -0,0 +1,44 @@ +# B.face + +A 60% keyboard with RGB that runs ps2avrgb natively. Please note that the B.face and B.fake have different switch matrices. Firmware on one, will not work on the other. + +Keyboard Maintainer: QMK Community +Hardware Supported: B.face PCB +Hardware Availability: [Winkeyless](https://winkeyless.kr/product/b-face-x2-pcb/) + +Make example for this keyboard (after setting up your build environment): + + make winkeyless/bface:default + +Flashing + +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 + brew 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). |