opensteno_qmk/keyboards/rainkeeb/readme.md
rainsff c41c8ff780
Add rainkeeb keyboard (#10875)
* Add rainkeeb

Add support for rainkeeb

* gpl license added

* updated

* Apply suggestions from code review

Co-authored-by: ridingqwerty <george.g.koenig@gmail.com>

* Apply suggestions from code review

Co-authored-by: ridingqwerty <george.g.koenig@gmail.com>

* Update info.json

* via keymap added

* updated keymap and .h to work properly

* fixed oled code oops

Co-authored-by: ridingqwerty <george.g.koenig@gmail.com>
2020-11-27 13:04:56 -05:00

24 lines
1.5 KiB
Markdown

# rainkeeb
![rainkeeb](https://i.imgur.com/GpVBRMw.jpg)
My first custom mech design. 4x10(ish), pro micro based, unibody, split, ortho (any more adjectives?), with OLED and (optional) rotary encoder.
![Default layout](https://i.imgur.com/rCOwsoy.png)
This is the default layout, at least the base layer. By default the OLED displays "rainkeeb" at the top in case you forget what you're typing on, a layer indicator below that (Default, Raised, Alt), and a WPM counter below that. Encoder toggles Play/Pause on click on the Default and Raised layers, and is supposed to RESET into flash-mode on the Alt layer but that's not working for some reason. Clockwise turn increases volume, scrolls down, and scrolls right on the Default, Raise, and Alt layers respectively. Counterclockwise does the opposite of the clockwise turns, you get the picture.
* Keyboard Maintainer: [rain](https://github.com/rainsff)
* Hardware Supported: rainkeeb PCB v1
* Hardware Availability: GB soon
Make example for this keyboard (after setting up your build environment):
make rainkeeb:default
To put reset into bootloader mode just push the reset button from the left side of the board using a pair of tweezers or similar object.
Install example for this keyboard:
make rainkeeb:default:flash
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).