summaryrefslogtreecommitdiffstats
path: root/keyboards/mechwild/bbs/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/mechwild/bbs/readme.md')
-rw-r--r--keyboards/mechwild/bbs/readme.md27
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)
+
+![BBS](https://i.imgur.com/XIjlzKOh.png)
+
+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.