aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/heliar/wm1_hotswap/readme.md
diff options
context:
space:
mode:
authorheliarmk <heliar@zju.edu.cn>2019-11-27 08:51:32 +0800
committerJames Young <18669334+noroadsleft@users.noreply.github.com>2019-11-26 16:51:32 -0800
commit2b318ba01b6e504bfe5f300f8459afc849e104b7 (patch)
tree6fdb0e2a9f3b38cde74584de1349a4c6fb0a377d /keyboards/heliar/wm1_hotswap/readme.md
parent2f3adc3e240fcb408d89b4501d6b4cdc5fe7350a (diff)
downloadfirmware-2b318ba01b6e504bfe5f300f8459afc849e104b7.tar.gz
firmware-2b318ba01b6e504bfe5f300f8459afc849e104b7.tar.bz2
firmware-2b318ba01b6e504bfe5f300f8459afc849e104b7.zip
[Keyboard] add keyboard wm1 (#7466)
* add new keyborad wm1 * 删除print信息 * add info.json and modified the default keymap.c * add keyboard name and maintainer in info.json * add readme.md file for new keyboard * add default/keymap/readme.md * modified the main readme file * change keyboard name from wm1 to wm1_hotswap * update readme * update imgur link in readme * update readme to add more pic and subtopic * change wm1 keyboard pic to direct show up * add copyright to config.h * modified the info.json to change the label * set the debug config to no in rule.mk * rename wn1.c wm1.h to wm1_hotswap.c, wm1_hotswap.h * fix spelling mistake * update the rule.mk to new version * fix the LED operation in wm1_hotswap.c * delete the definition of kc_trns * change layout to conform to electrical position * delete backslashes in keymap.c * update info.json according to the layout * change the return of led_update_kb * delete unused comments in rule.mk * delete unused definition in wm1_hotswap.h * add a if statement to support user override func * fix comment in rules.mk
Diffstat (limited to 'keyboards/heliar/wm1_hotswap/readme.md')
-rw-r--r--keyboards/heliar/wm1_hotswap/readme.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/keyboards/heliar/wm1_hotswap/readme.md b/keyboards/heliar/wm1_hotswap/readme.md
new file mode 100644
index 000000000..f6ba7e185
--- /dev/null
+++ b/keyboards/heliar/wm1_hotswap/readme.md
@@ -0,0 +1,19 @@
+# Wm1 ergonomic Keyboard alternative hotswap PCB
+### Original Wm1 Keyboard
+![Wm1 keyboard with SA Pulse](https://i.imgur.com/f0zRPTB.png)
+### Pcb front side
+![Wm1 front side of Pcb](https://i.imgur.com/2W2G3V6.jpg)
+### Pcb back side
+![Wm1 back side of Pcb](https://i.imgur.com/nGxVJGI.jpg)
+
+A ergonomic 68 key keyboard's hotswap-type PCB which is made by heliar and this PCB is compatible with the wm1 keyboard is designed by Hoq.
+
+* Keyboard Maintainer: [Heliar](https://github.com/heliarmk)
+* Hardware Supported: Hotswap type
+* Hardware Availability: [Heliar](https://github.com/heliarmk)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make heliar/wm1_hotswap: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).