summaryrefslogtreecommitdiff
path: root/keyboards/budgy/readme.md
diff options
context:
space:
mode:
authorAlex Miller <39163867+doesntfazer@users.noreply.github.com>2023-04-04 17:36:23 -0400
committerGitHub <noreply@github.com>2023-04-04 14:36:23 -0700
commitf7176f070fd2b1cd6df25774f4de842200a7a342 (patch)
tree68f9be1ec63ae45c941ed95a2c16127afebb72dd /keyboards/budgy/readme.md
parent687883cf7d68deedfd1678af1195c4d6f35456df (diff)
[Keyboard] Add Budgy and Crowboard Keyboards (#19141)
Co-authored-by: jack <0x6a73@protonmail.com> Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Drashna Jaelre <drashna@live.com>
Diffstat (limited to 'keyboards/budgy/readme.md')
-rw-r--r--keyboards/budgy/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/budgy/readme.md b/keyboards/budgy/readme.md
new file mode 100644
index 0000000000..a164a87acf
--- /dev/null
+++ b/keyboards/budgy/readme.md
@@ -0,0 +1,27 @@
+# budgy
+
+![budgy](https://i.imgur.com/6kjxmSMh.jpeg)
+
+34 key, diodeless, RP2040 based, budget keyboard.
+
+* Keyboard Maintainer: [KeyboardDweebs](https://github.com/doesntfazer)
+* Hardware Supported: Raspberry Pi Pico
+* Hardware Availability: [Github Page](https://github.com/doesntfazer/Budgy) Buy Directly from [Keyboard Dweebs](https://keyboarddweebs.net/)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make budgy:default
+
+Flashing example for this keyboard:
+
+ make budgy: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 (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 `QK_BOOT` if it is available