summaryrefslogtreecommitdiff
path: root/keyboards/handwired/carpolly/readme.md
diff options
context:
space:
mode:
authorPollyV1 <70621744+PollyV1@users.noreply.github.com>2022-01-12 02:08:35 +0800
committerGitHub <noreply@github.com>2022-01-11 10:08:35 -0800
commit1fdc42155a19a415b2d574ccbf61aac45e6543aa (patch)
treee1a455e406c137f5143cde1b0dc26945aa33ee4a /keyboards/handwired/carpolly/readme.md
parent349ca4b7ff0c98baedbeb9096442231e2267c817 (diff)
downloadqmk_firmware-1fdc42155a19a415b2d574ccbf61aac45e6543aa.tar.gz
qmk_firmware-1fdc42155a19a415b2d574ccbf61aac45e6543aa.zip
[Keyboard] Carpolly (#15778)
Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/handwired/carpolly/readme.md')
-rw-r--r--keyboards/handwired/carpolly/readme.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/keyboards/handwired/carpolly/readme.md b/keyboards/handwired/carpolly/readme.md
new file mode 100644
index 0000000000..e79bd543e6
--- /dev/null
+++ b/keyboards/handwired/carpolly/readme.md
@@ -0,0 +1,30 @@
+# carpolly
+
+![carpool](https://i.imgur.com/w691sNnh.jpg)
+
+* Keyboard Maintainer: Paul Enrico N. Viola (https://github.com/PollyV1)
+* Hardware Supported: Teensy 2 controller
+* Hardware Availability: [PollyV1] https://github.com/PollyV1/Carpolly
+
+carpolly - a handwired keyboard on a teensy 2 controller
+
+## Make
+
+Make example for this keyboard (after setting up your build environment):
+
+ make handwired/carpolly:default
+
+## Flashing
+
+Flashing example for this keyboard:
+
+ make handwired/carpolly: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:
+
+* **Physical reset button**: Briefly press the RESET button on the controller.
+* **Keycode in layout**: Longpress ALT + ESC