summaryrefslogtreecommitdiffstats
path: root/keyboards/cannonkeys/crin/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/cannonkeys/crin/readme.md')
-rw-r--r--keyboards/cannonkeys/crin/readme.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/keyboards/cannonkeys/crin/readme.md b/keyboards/cannonkeys/crin/readme.md
new file mode 100644
index 0000000000..2da8bd6bcc
--- /dev/null
+++ b/keyboards/cannonkeys/crin/readme.md
@@ -0,0 +1,18 @@
+# Crin by Bachoo
+
+* Keyboard Maintainer: [Andrew Kannan](https://github.com/awkannan)
+* Hardware Supported: STM32F072CBT6
+
+Make example for this keyboard (after setting up your build environment):
+
+ make cannonkeys/crin:default
+
+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 (usually the top left key or Escape) and plug in the keyboard
+* **Physical reset button**: Toggle the switch on the back of the pcb to "0" and briefly press the button on the back of the PCB
+* **Keycode in layout**: Press the key mapped to `RESET` if it is available