summaryrefslogtreecommitdiffstats
path: root/keyboards/quokka/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/quokka/readme.md')
-rw-r--r--keyboards/quokka/readme.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/keyboards/quokka/readme.md b/keyboards/quokka/readme.md
new file mode 100644
index 0000000000..6acf5bc462
--- /dev/null
+++ b/keyboards/quokka/readme.md
@@ -0,0 +1,26 @@
+# Quokka
+
+![Quokka](https://i.imgur.com/zqbb56ch.jpeg)
+
+A split ortholinear keyboard designed for the small handed.
+
+* Keyboard Maintainer: [dlford](https://github.com/dlford/), [dlford.io](https://www.dlford.io)
+* Hardware Supported: Quokka PCB, Adafruit KB2040
+* Hardware Availability: [PCB, Case Data, and Build Guide](https://github.com/dlford/quokka)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make quokka:default
+
+Flashing example for this keyboard:
+
+ make quokka: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**: Quickly double press and release the reset button on the the PCB
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available