summaryrefslogtreecommitdiff
path: root/keyboards/cheshire/curiosity/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/cheshire/curiosity/readme.md')
-rw-r--r--keyboards/cheshire/curiosity/readme.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/keyboards/cheshire/curiosity/readme.md b/keyboards/cheshire/curiosity/readme.md
new file mode 100644
index 0000000000..dbde94130b
--- /dev/null
+++ b/keyboards/cheshire/curiosity/readme.md
@@ -0,0 +1,20 @@
+# Cheshire Curiosity PCB
+
+Cheshire Alice Keyboard Replacement PCB
+
+* Keyboard Maintainer: [sidcarter](https://github.com/sidcarter)
+* Hardware Supported: Cheshire Curiosity PCB, STM32F072CBT6
+* Designed By: Nightingale Studios/PhoenixStarr
+
+Make example for this keyboard (after setting up your build environment):
+
+ make cheshire/curiosity:default:flash
+
+If you are flashing this keyboard/pcb for the first time:
+
+ * Set the dip switch on the reverse of the PCB to 1
+ * Hit the reset button and then do
+ * make cheshire/curiosity:default
+ * After flashing the keyboard successfully, you can reset the dip switch back to 0
+
+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).