summaryrefslogtreecommitdiff
path: root/keyboards/moky/moky88/readme.md
diff options
context:
space:
mode:
authorVertorWang <1479115496@qq.com>2024-02-20 05:51:04 +0800
committerGitHub <noreply@github.com>2024-02-19 14:51:04 -0700
commit672986a0780d1168a07e285cafe72fcbfce2f7fa (patch)
tree06c828c8ddc31e927695e2a23a07e121ba38885e /keyboards/moky/moky88/readme.md
parent958ddea52e915b9b12d5bfac5c84bf5b0eb75184 (diff)
[Keyboard] Add moky88 (#22954)
* Update * 代码对齐 * 修改键盘名称 * 增加Readme * Add copyright notice * Update keyboards/moky/moky88/info.json Delete solid_color Co-authored-by: Joel Challis <git@zvecr.com> * Update keyboards/moky/moky88/info.json Co-authored-by: Joel Challis <git@zvecr.com> * Update keyboards/moky/moky88/moky88.c Co-authored-by: Joel Challis <git@zvecr.com> * Update keyboards/moky/moky88/info.json Co-authored-by: Joel Challis <git@zvecr.com> * Update keyboards/moky/moky88/info.json Co-authored-by: Joel Challis <git@zvecr.com> * Update keyboards/moky/moky88/config.h Co-authored-by: Joel Challis <git@zvecr.com> * Update keyboards/moky/moky88/keymaps/via/keymap.c Co-authored-by: Joel Challis <git@zvecr.com> * Update keyboards/moky/moky88/keymaps/default/keymap.c Co-authored-by: Joel Challis <git@zvecr.com> * Update keyboards/moky/moky88/info.json Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com> * Update keyboards/moky/moky88/keymaps/default/keymap.c Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com> * Update keyboards/moky/moky88/keymaps/via/keymap.c Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com> * Update keyboards/moky/moky88/config.h Co-authored-by: Joel Challis <git@zvecr.com> * Add a key to enter the bootloader, and add instructions to the readme documentation * delete maintainer * add default/rules.mk * Update readme.md * Update readme.md --------- Co-authored-by: vertor <zhen.wang@westberrytech.com> Co-authored-by: Joel Challis <git@zvecr.com> Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com>
Diffstat (limited to 'keyboards/moky/moky88/readme.md')
-rw-r--r--keyboards/moky/moky88/readme.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/keyboards/moky/moky88/readme.md b/keyboards/moky/moky88/readme.md
new file mode 100644
index 0000000000..62dc876eb2
--- /dev/null
+++ b/keyboards/moky/moky88/readme.md
@@ -0,0 +1,26 @@
+# moky88
+![moky/moky88](https://i.imgur.com/lssV4bq.png)
+
+An in-switch RGB LED keyboard with RGB underglow.
+
+* Keyboard Maintainer: [Vertor](https://github.com/VertorWang)
+* Hardware Supported: moky88
+* Hardware Availability: Private GB
+
+Make example for this keyboard (after setting up your build environment):
+
+ make moky/moky88:default
+
+Flashing example for this keyboard:
+
+ make moky/moky88:default:flash
+
+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).
+
+## Bootloader
+
+Enter the bootloader in 3 ways:
+
+* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
+* **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available