summaryrefslogtreecommitdiff
path: root/keyboards/tkc/osav2/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/tkc/osav2/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/tkc/osav2/readme.md')
-rw-r--r--keyboards/tkc/osav2/readme.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/keyboards/tkc/osav2/readme.md b/keyboards/tkc/osav2/readme.md
new file mode 100644
index 0000000000..749ffe0870
--- /dev/null
+++ b/keyboards/tkc/osav2/readme.md
@@ -0,0 +1,15 @@
+# TKC OSA v2 (One Sweet Alice)
+
+![OSA v2](https://i.imgur.com/U2x7TQ8.jpg)
+
+The TKC OSA v2 is an ATMega32u4 powered, USB Type C, Alice compatible PCB and was created specifically for the OSA case, but with considerations to make it compatible with the Lubrigante acrylic cases (except for the Type C connector it should also be compatible with original TGR Alice cases).
+
+* Keyboard Maintainer: [Terry Mathews](https://github.com/TerryMathews/)
+* Hardware Supported: TKC OSA v2 PCB
+* Hardware Availability: https://thekey.company/collections/osav2-keyboard
+
+Make example for this keyboard (after setting up your build environment):
+
+ make tkc/osav2: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).