summaryrefslogtreecommitdiff
path: root/keyboards/wolfmarkclub/wm1/readme.md
diff options
context:
space:
mode:
authorMechMerlin <30334081+mechmerlin@users.noreply.github.com>2020-05-21 13:34:28 -0700
committerGitHub <noreply@github.com>2020-05-21 13:34:28 -0700
commit9e4037465afe5a6e1888d4bf2a0b80fee9beed99 (patch)
tree51750172874782ec2bec916f8052d6b2d4b172ff /keyboards/wolfmarkclub/wm1/readme.md
parentfd4f1029771fba4d620ca6cfc9710ccbba421206 (diff)
[Keyboard] Wolfmark Club WM1 (#9121)
* do the basic port for the WM1 * with much help from tzarc, get the addresses correct * make the keymap more closely mirror what the board has * Add QMK Configurator support * update the readme * get indicator leds working * enable RGB underglow * fix up rgb underglow * add notes regarding existence of backlight * Update keyboards/wolfmarkclub/wm1/readme.md * Update keyboards/wolfmarkclub/wm1/rules.mk * Update keyboards/wolfmarkclub/wm1/rules.mk * Update keyboards/wolfmarkclub/wm1/rules.mk * Update keyboards/wolfmarkclub/wm1/rules.mk * Update keyboards/wolfmarkclub/wm1/config.h * Update keyboards/wolfmarkclub/wm1/ld/wm1_f103.ld * Update keyboards/wolfmarkclub/wm1/bootloader_defs.h * Update keyboards/wolfmarkclub/wm1/config.h * Update keyboards/wolfmarkclub/wm1/rules.mk * Update keyboards/wolfmarkclub/wm1/wm1.c * Update keyboards/wolfmarkclub/wm1/wm1.c * Update keyboards/wolfmarkclub/wm1/rules.mk * Update keyboards/wolfmarkclub/wm1/rules.mk * Update keyboards/wolfmarkclub/wm1/readme.md * Update keyboards/wolfmarkclub/wm1/rules.mk * Update keyboards/wolfmarkclub/wm1/rules.mk * Update keyboards/wolfmarkclub/wm1/rules.mk * Update keyboards/wolfmarkclub/wm1/rules.mk * update readme
Diffstat (limited to 'keyboards/wolfmarkclub/wm1/readme.md')
-rw-r--r--keyboards/wolfmarkclub/wm1/readme.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/keyboards/wolfmarkclub/wm1/readme.md b/keyboards/wolfmarkclub/wm1/readme.md
new file mode 100644
index 0000000000..74e92b2ee1
--- /dev/null
+++ b/keyboards/wolfmarkclub/wm1/readme.md
@@ -0,0 +1,17 @@
+# Wolfmark Club WM1
+
+![WM1](https://i.imgur.com/TDFp97yl.jpg)
+
+Split Ergo 65% keyboard
+
+* Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)
+* Hardware Supported: WM1
+* Hardware Availability: Available through China run Group Buy.
+
+Make example for this keyboard (after setting up your build environment):
+
+ make wolfmarkclub/wm1:default
+
+**Reset Key**: Hold the `Esc` key while plugging in your cable, and the board will appear as a USB drive on your computer.
+
+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).