summaryrefslogtreecommitdiff
path: root/keyboards/shoc/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/shoc/readme.md')
-rw-r--r--keyboards/shoc/readme.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/keyboards/shoc/readme.md b/keyboards/shoc/readme.md
new file mode 100644
index 0000000000..4f81d47efb
--- /dev/null
+++ b/keyboards/shoc/readme.md
@@ -0,0 +1,21 @@
+# Shoc
+
+![Shoc](https://i.imgur.com/k00Uz6wh.jpg)
+
+A 64 Key keyboard with an Oled Display.
+
+* Keyboard Maintainer: [JannikB5825](https://github.com/JannikB5825)
+* Hardware Supported: Shoc PCB, Pro Micro 5V/16MHz and compatible.
+* Hardware Availability: [Shoc](https://github.com/JannikB5825/Shoc).
+
+Make example for this keyboard (after setting up your build environment):
+
+ make shoc:default
+
+Flashing example for this keyboard:
+
+ make shoc:default:flash
+
+## Bootloader
+
+Briefly press the button along the outer edge of the PCB next to the microcontroller.