diff options
| author | Kyle McCreery <mccreery.kyle@gmail.com> | 2022-07-14 02:26:13 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-07-13 23:26:13 -0700 |
| commit | acc11f4941649a92fad4588e0598ee808e493cb1 (patch) | |
| tree | 2f22e722c5eb661f8ef5be7efc359bd8950c1c15 /keyboards/mechwild/bbs/readme.md | |
| parent | 99e9e1b8e70b7b6a0cc03a6672f2512b472fb650 (diff) | |
[Keyboard] MechWild BB Steno (#17163)
* allowing the kt60 file to be modified so I can do things while waiting for it to be fixed upstream
* Initial commit
* testing modes
* working on puckbuddy firmware. This is all working for now but need to clean it up and personalize it.
* needs to be updated from vial build
* prepping for PR
* added rgb mode cycling to fn1 since it isn't on the encoder for these maps
* shipping firmware built. Need to clean up readme and info.json layout
* removing puckbuddy files from this branch
* readme done, prepping for PR
* info.json updated prepping for PR
* Restore cirque driver that was modified from puckbuddy testing on this branch
* applying changes from review
* Update keyboards/mechwild/bbs/bbs.c
* Fixed info.json
* Apply suggestions from code review
Diffstat (limited to 'keyboards/mechwild/bbs/readme.md')
| -rw-r--r-- | keyboards/mechwild/bbs/readme.md | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/mechwild/bbs/readme.md b/keyboards/mechwild/bbs/readme.md new file mode 100644 index 0000000000..b13e8fb54e --- /dev/null +++ b/keyboards/mechwild/bbs/readme.md @@ -0,0 +1,27 @@ +# BB Steno (BBS) + + + +A bare-bones stenography keyboard. No bells or whistles. Simple, cheap, effective, steno. + +* Keyboard Maintainer: [Kyle McCreery](https://github.com/kylemccreery) +* Hardware Supported: BBS v0.1 +* Hardware Availability: [BBS on MechWild](https://mechwild.com/product/bb-steno/) + +Make example for this keyboard (after setting up your build environment): + + make mechwild/bbs:default + +Flashing example for this keyboard: + + make mechwild/bbs: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). + +## Bootloader + +Enter the bootloader in 3 ways: + +* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (assigned to the top left key) and plug in the keyboard while holding it. +* **Physical reset button**: Press and hold the boot0 button on the blackpill, tap and release the nrst button on the blackpill, then release the boot0 button. +* **Keycode in layout**: Press the key mapped to `RESET` if it is available. |