summaryrefslogtreecommitdiff
path: root/keyboards/suavity/ehan/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/suavity/ehan/readme.md')
-rw-r--r--keyboards/suavity/ehan/readme.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/keyboards/suavity/ehan/readme.md b/keyboards/suavity/ehan/readme.md
new file mode 100644
index 0000000000..76d997f6ed
--- /dev/null
+++ b/keyboards/suavity/ehan/readme.md
@@ -0,0 +1,23 @@
+# ehan: A 10.5° Split TKL Keyboard designed by Suavity Designs | QMK Firmware
+
+![Imgur](https://i.imgur.com/bAiBbjgh.png)
+
+## Introduction
+
+ehan is a 10.5° Split TKL that supports 3U Spacebars,
+
+* Keyboard Maintainer: [Suavity Designs](https://github.com/suavity)
+* Hardware Supported: ARM STM32F072CBT6
+* Hardware Availability: [suavity.cc/ehan](https://suavity.cc/keyboards/ehan/)
+
+The latest iteration of the PCB is v3.00 as of 07/'21. This is noted on the back of the PCB.
+* Default Keymap: [See here](http://www.keyboard-layout-editor.com/#/gists/6504b0b388736213f43b64df1d576139)
+* PCB Supported Layouts: [See here](http://www.keyboard-layout-editor.com/#/gists/9aab5e15a89469138da760f968df26ae)
+
+## How to compile
+
+After setting up your build environment, you can compile the ehan default keymap by using:
+
+ make suavity/ehan: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).