summaryrefslogtreecommitdiff
path: root/keyboards/projectcain/relic/readme.md
diff options
context:
space:
mode:
authorprojectcain <71684775+projectcain@users.noreply.github.com>2022-07-15 20:01:52 -0500
committerGitHub <noreply@github.com>2022-07-15 18:01:52 -0700
commitf5333e9136ae7158f0029abb0ed9d4410ece2ea2 (patch)
tree277d1ba12febf1758076b21d7775334f744286b9 /keyboards/projectcain/relic/readme.md
parentba4ba66b2fadc31a847f51f49d365d82b0552797 (diff)
[Keyboard] add ProjectCain Relic (#15577)
* Adding relic keyboard * Update keyboards/projectcain/relic/relic.c * Update keyboards/projectcain/relic/relic.c * Update keyboards/projectcain/relic/rules.mk * Update keyboards/projectcain/relic/rules.mk * Update keyboards/projectcain/relic/rules.mk * Update config.h * Update config.h * Update keyboards/projectcain/relic/rules.mk * Update keyboards/projectcain/relic/readme.md * Update keyboards/projectcain/relic/info.json * Update keyboards/projectcain/relic/config.h * Update keyboards/projectcain/relic/config.h
Diffstat (limited to 'keyboards/projectcain/relic/readme.md')
-rw-r--r--keyboards/projectcain/relic/readme.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/keyboards/projectcain/relic/readme.md b/keyboards/projectcain/relic/readme.md
new file mode 100644
index 0000000000..5f2606c543
--- /dev/null
+++ b/keyboards/projectcain/relic/readme.md
@@ -0,0 +1,17 @@
+# relic
+
+![relic](https://i.imgur.com/oqveJc2h.jpg)
+
+This is an 11-unit unibody split keyboard with an exploded spacebar cluster on bottom
+
+* Keyboard Maintainer: [projectcain](https://github.com/yourusername)
+* Hardware Supported: Relic PCB
+* Hardware Availability: mechvault.net
+
+To reset the keyboard into bootloader mode, short the two pads labeled "Reset" on the left side of the pcb
+
+Make example for this keyboard (after setting up your build environment):
+
+ make projectcain/relic: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).