aboutsummaryrefslogtreecommitdiff
path: root/keyboards/sneakbox/lilbae/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/sneakbox/lilbae/readme.md')
-rw-r--r--keyboards/sneakbox/lilbae/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/sneakbox/lilbae/readme.md b/keyboards/sneakbox/lilbae/readme.md
new file mode 100644
index 0000000000..f637df1c1b
--- /dev/null
+++ b/keyboards/sneakbox/lilbae/readme.md
@@ -0,0 +1,27 @@
+# Sneakbox Lil' BAE
+
+![Lil' BAE](https://i.imgur.com/WGNgOhM.jpeg)
+
+A small macropad featuring key positions for a Big-Ass Enter (Reverse L-shaped enter key)
+
+Keyboard Maintainer: [mujimanic](https://sneakbox.com)
+Hardware Supported: Lil' BAE Case
+Hardware Availability: [sneakbox.design](https://sneakbox.com/products/lil-bae-macropad)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make sneakbox/lilbae:default
+
+Flashing example for this keyboard:
+
+ make sneakbox/lilbae: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,2) in the matrix (position mapped to ANSI enter key) and plug in the keyboard
+* **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available