summaryrefslogtreecommitdiff
path: root/keyboards/kingly_keys/soap/readme.md
diff options
context:
space:
mode:
authorErovia <Erovia@users.noreply.github.com>2020-10-25 15:23:42 +0000
committerGitHub <noreply@github.com>2020-10-25 15:23:42 +0000
commitad86894ae7d5fbb7aed697d9f576cd186bfd1c9c (patch)
treec5ffe570301b95699d93566d5b9453bda203a7ae /keyboards/kingly_keys/soap/readme.md
parentaf455a8368dc564df51f9657b04932956ccf580b (diff)
Rename keyboard-level readmes to lower-case (#10759)
This is the recommendation in the [PR Checklist](https://docs.qmk.fm/#/pr_checklist?id=keyboard-prs) and it will make working with them easier in the CLI/API/etc.
Diffstat (limited to 'keyboards/kingly_keys/soap/readme.md')
-rw-r--r--keyboards/kingly_keys/soap/readme.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/keyboards/kingly_keys/soap/readme.md b/keyboards/kingly_keys/soap/readme.md
new file mode 100644
index 0000000000..0e32244d2f
--- /dev/null
+++ b/keyboards/kingly_keys/soap/readme.md
@@ -0,0 +1,16 @@
+SOAP
+===
+
+![SOAP](https://i.imgur.com/6h6O4QP.png)
+
+A Sanitary, "SOAP" Themed, Macro Pad by [Garret G.](https://github.com/TheRoyalSweatshirt) a.k.a. [/u/The_Royal](https://www.reddit.com/user/The_Royal)
+
+Keyboard Maintainer: [Garret G.](https://github.com/TheRoyalSweatshirt) a.k.a. [/u/The_Royal](https://www.reddit.com/user/The_Royal/) of Reddit.
+Hardware Supported: SOAP rev1.0, rev2.0 PCB
+Hardware Availability: [Kingly-Keys.xyz](https://kingly-keys.xyz/) - (Through GB)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make kingly_keys/soap: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)