summaryrefslogtreecommitdiff
path: root/keyboards/suavity/ehan/readme.md
diff options
context:
space:
mode:
authorHenry Lum <20608904+suavity@users.noreply.github.com>2022-07-15 14:06:19 -0700
committerGitHub <noreply@github.com>2022-07-15 14:06:19 -0700
commitba4ba66b2fadc31a847f51f49d365d82b0552797 (patch)
tree455169439279916c333bced33e4de6884a13582c /keyboards/suavity/ehan/readme.md
parent09b0d3e0ed3a9ad897558421d13f59f40831c44c (diff)
[Keyboard] eHan Keyboard (#15861)
* Compiled Suavity QMK Directory * updated info.json's name from 'LAYOUT_default' to 'LAYOUT_default_split' * updated rules.mk to reflect new layout name of each keymap * Updated hanjie.h to reflect physical matrix of PCB * switched info.json key matrix from split backspace to 2U backspace to better reflect electrical matrix * updated keymap.c key matrix to reflect PCB electrical matrix * updated keymap.c key matrix t oreflect PCB electrical matrix * removed split left shift from physical matrix for default_split layout * removed split left shift physical & electrical default_split layout * removed split left shift from physical matrix for default_split layout * removed split left shift from physical matrix for default_split layout * updated qmk and via keymap.c and hanjie.h files to reflect pcb electrical matrix * changed diode direction from row2col to col2row * fixed false keycode triggers * updated via keymaps * added 's' * added ehan branch for development * updated readme.md * updated ehan.h * updated readme.md * updated ehan.h layout * added keymap.c and updated ehan.h * progress * compiled qmk * updated matrix column and row pin out * updated QMK default ansi keymap * added VIA ansi_default keymaps * corrected col 15's pin out to be pin B9, not C13 * Update keyboards/suavity/ehan/config.h * Update keyboards/suavity/ehan/info.json * Update keyboards/suavity/ehan/rules.mk * Update keyboards/suavity/hanjie/rules.mk * Update keyboards/suavity/hanjie/rules.mk * Update keyboards/suavity/hanjie/keymaps/via/rules.mk * Update keyboards/suavity/ehan/rules.mk * changed readme.md's picturefrom html to markdown * updated traces & diode placement * Apply suggestions from code review Remove trailing backslashes from keymaps (per fauxpark) * Apply suggestions from code review Remove `BOOTMAGIC_ENABLE = lite` from `keyboards/suavity/ehan/keymaps/via/rules.mk` (per fauxpark) * Apply suggestions from code review Update formatting of `keyboards/suavity/ehan/rules.mk` (per fauxpark) * Update keyboards/suavity/ehan/readme.md Fix image URL * Update keyboards/suavity/ehan/config.h Remove trailing comma in MATRIX_COL_PINS definition
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).