summaryrefslogtreecommitdiff
path: root/keyboards/cheshire/curiosity/readme.md
diff options
context:
space:
mode:
authorSid Carter <sidcarter@users.noreply.github.com>2019-12-30 10:29:36 -0500
committerfauxpark <fauxpark@gmail.com>2019-12-31 02:29:36 +1100
commitf6bdb6afba80f451f9866517aafc507f1f15c091 (patch)
tree810a28c5531795d9be82b1c9edfa7246a4968ac1 /keyboards/cheshire/curiosity/readme.md
parent559ef215638e82de75e3e9221baf4909990f4f53 (diff)
New PCB - Curiosity - Alice Layout PCB (#7725)
* add new keyboard * update config to use * confirm config that works * fix the keymaps and what not * default keymap update * update readme * update and remove unncessary files * update IDs and remove unused definitions * update readme * add new keyboard * update config to use * confirm config that works * fix the keymaps and what not * default keymap update * update readme * update and remove unncessary files * update IDs and remove unused definitions * update readme * remove unused stuff * update default keymap and add my own with layer indicator LEDs * update README * add crd's layout as part of the default as well * some specific space fixes * update readme for flashing * remove code and use mcu selection instead. yay! * remove vlk from default and enable velocikeys in madhatter * remove BL_ from default * and remove BL_ from madhatter as well * Update keyboards/cheshire/curiosity/keymaps/crd/keymap.c Co-Authored-By: fauxpark <fauxpark@gmail.com> Co-authored-by: Khader Syed <35927972+chapter63@users.noreply.github.com> Co-authored-by: fauxpark <fauxpark@gmail.com>
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).