summaryrefslogtreecommitdiffstats
path: root/keyboards/synthandkeys/bento_box/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/synthandkeys/bento_box/readme.md')
-rw-r--r--keyboards/synthandkeys/bento_box/readme.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/keyboards/synthandkeys/bento_box/readme.md b/keyboards/synthandkeys/bento_box/readme.md
new file mode 100644
index 0000000000..32ce47a013
--- /dev/null
+++ b/keyboards/synthandkeys/bento_box/readme.md
@@ -0,0 +1,26 @@
+# synthandkeys/bento_box
+
+![synthandkeys/bento_box](https://i.imgur.com/J8NkYO8h.jpeg)
+
+The Bento Box is a 15-key, 3-encoder macropad running on QMK.
+
+* Keyboard Maintainer: [Synth-and-Keys](https://github.com/Synth-and-Keys)
+* Hardware Supported: Bento Box PCB
+* Hardware Availability: https://www.etsy.com/shop/SynthandKeys
+
+Make example for this keyboard (after setting up your build environment):
+
+ make synthandkeys/bento_box:default
+
+Flashing example for this keyboard:
+
+ make synthandkeys/bento_box: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 2 ways:
+
+* **Bootmagic reset**: Hold down the top left key in the group of 9 and plug in the keyboard
+* **Physical reset button**: Hold down the reset button on the back of the PCB for 5 seconds and release