summaryrefslogtreecommitdiffstats
path: root/keyboards/tanuki/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/tanuki/readme.md')
-rw-r--r--keyboards/tanuki/readme.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/keyboards/tanuki/readme.md b/keyboards/tanuki/readme.md
new file mode 100644
index 000000000..331df5b2e
--- /dev/null
+++ b/keyboards/tanuki/readme.md
@@ -0,0 +1,15 @@
+# Tanuki
+
+![Tanuki](https://github.com/SethSenpai/Tanuki/blob/master/Img/glamour1.jpg?raw=true)
+
+The QMK firmware for the Tanuki 40% keyboard. The other files needed for construction can be found in the [Tanuki repo](https://github.com/SethSenpai/Tanuki).
+
+Keyboard Maintainer: [SethSenpai](https://github.com/SethSenpai)
+Hardware Supported: Tanuki pcb, pro micro
+Hardware Availability: [Tanuki repo](https://github.com/SethSenpai/Tanuki)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make tanuki:default
+
+See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information.