summaryrefslogtreecommitdiff
path: root/keyboards/tweetydabird/chameleon/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/tweetydabird/chameleon/readme.md')
-rw-r--r--keyboards/tweetydabird/chameleon/readme.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/keyboards/tweetydabird/chameleon/readme.md b/keyboards/tweetydabird/chameleon/readme.md
new file mode 100644
index 0000000000..0d8693c8ff
--- /dev/null
+++ b/keyboards/tweetydabird/chameleon/readme.md
@@ -0,0 +1,28 @@
+# Chameleon
+
+![chameleon](https://i.imgur.com/BEAzgK8h.jpeg)
+
+Chameleon is a 46-60 Key Grid Ortho Keyboard that can be built as both 5x12 and 4x12 with several optional bottom row layouts.
+
+* Keyboard Maintainer: [TweetyDaBird](https://github.com/TweetyDaBird)
+* Hardware Supported: Chameleon 46-60 key PCB
+* Hardware Availability: [Lectronz Store](https://lectronz.com/stores/tweetys-wild-thinking)
+* Hardware Design: [GitHub](https://github.com/TweetyDaBird/Chameleon)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make tweetydabird/chameleon:default
+
+Flashing example for this keyboard:
+
+ make tweetydabird/chameleon: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 (top left) and plug in the keyboard
+* **Physical reset/boot buttons**: Hold the 'BOOT' button and briefly press 'RESET' on the back of the PCB
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if available on your keymap