summaryrefslogtreecommitdiff
path: root/keyboards/handwired/swiftrax/bumblebee/readme.md
diff options
context:
space:
mode:
authorBrandon Claveria <48102030+swiftrax@users.noreply.github.com>2022-01-08 16:13:37 -0800
committerGitHub <noreply@github.com>2022-01-08 16:13:37 -0800
commitfc8346e0b3d601aadf37fd7a1e708910cee22f75 (patch)
tree13324ed5b6b9abef3bcebf4299f38f88459cd1f9 /keyboards/handwired/swiftrax/bumblebee/readme.md
parent4b0aa1a2af5934aad40c21ceb9f83cf6b5034d5b (diff)
[keyboard] BumbleBee handwired (#14908)
* add bumblebee * change keymaps * change PID * update info.json * Apply suggestions from code review * Update keyboards/handwired/swiftrax/bumblebee/rules.mk * update readme.md * Update keyboards/handwired/swiftrax/bumblebee/info.json * edit keymaps * Update keyboards/handwired/swiftrax/bumblebee/rules.mk * Update keyboards/handwired/swiftrax/bumblebee/bumblebee.h * Update keyboards/handwired/swiftrax/bumblebee/info.json * Update keyboards/handwired/swiftrax/bumblebee/keymaps/default/keymap.c * Update keyboards/handwired/swiftrax/bumblebee/keymaps/default/keymap.c * Update keyboards/handwired/swiftrax/bumblebee/keymaps/default/keymap.c * Update keyboards/handwired/swiftrax/bumblebee/keymaps/via/keymap.c * Update keyboards/handwired/swiftrax/bumblebee/keymaps/via/keymap.c * Update keyboards/handwired/swiftrax/bumblebee/keymaps/via/keymap.c * Update keyboards/handwired/swiftrax/bumblebee/keymaps/via/keymap.c
Diffstat (limited to 'keyboards/handwired/swiftrax/bumblebee/readme.md')
-rw-r--r--keyboards/handwired/swiftrax/bumblebee/readme.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/keyboards/handwired/swiftrax/bumblebee/readme.md b/keyboards/handwired/swiftrax/bumblebee/readme.md
new file mode 100644
index 0000000000..32091cb83b
--- /dev/null
+++ b/keyboards/handwired/swiftrax/bumblebee/readme.md
@@ -0,0 +1,21 @@
+# BumbleBee
+
+A 50% keyboard with a bunch of fun features
+
+* Keyboard Maintainer: Swiftrax
+* Hardware Supported: BumbleBee
+* Hardware Availability: https://github.com/swiftrax
+
+## Bootloader
+
+Enter the bootloader in 3 ways:
+
+* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) 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 `RESET` if it is available
+
+Make example for this keyboard (after setting up your build environment):
+
+ make handwired/swiftrax/bumblebee:default
+
+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).