summaryrefslogtreecommitdiff
path: root/keyboards/shoc/readme.md
diff options
context:
space:
mode:
authorJannik Becker <89019698+JannikB5825@users.noreply.github.com>2022-09-02 05:48:24 +0200
committerGitHub <noreply@github.com>2022-09-01 20:48:24 -0700
commit8c793c1a43c5429b2204b55b6ba507ed822e08d4 (patch)
treebf98c0ad3190f619ab28ef42f96f358cadc2f9e0 /keyboards/shoc/readme.md
parent26814ca060829e68e167c90b24c59c37159a2cce (diff)
[Keyboard] Add Shoc Keyboard (#18143)
Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Ryan <fauxpark@gmail.com>
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.