aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/the_royal/schwann/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/the_royal/schwann/readme.md')
-rw-r--r--keyboards/the_royal/schwann/readme.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/keyboards/the_royal/schwann/readme.md b/keyboards/the_royal/schwann/readme.md
new file mode 100644
index 000000000..bb0c27a9a
--- /dev/null
+++ b/keyboards/the_royal/schwann/readme.md
@@ -0,0 +1,15 @@
+# Schwann PCB
+
+![schwann_render](https://i.imgur.com/04uaN8xl.jpg)
+
+A simple, HHKB ortho PCB, designed for use with the Neuron Keyboard by Wallet Burner
+
+* Keyboard Maintainer: [TheRoyalSweatshirt](https://github.com/TheRoyalSweatshirt) a.k.a [The_Royal](https://reddit.com/u/The_Royal)
+* Hardware Supported: Rev0.2 and Rev0.5 Schwann PCB
+* Hardware Availability: Private Message, Group buy, or self-procurement via the open sourced [Schwann Documentation](https://github.com/TheRoyalSweatshirt/The_Royal_Projects/tree/schwann/PCBs/Schwann_PCB).
+
+Make example for this keyboard (after setting up your build environment):
+
+ make the_royal/schwann: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).