summaryrefslogtreecommitdiffstats
path: root/keyboards/wuque/promise87/wkl/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/wuque/promise87/wkl/readme.md')
-rw-r--r--keyboards/wuque/promise87/wkl/readme.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/keyboards/wuque/promise87/wkl/readme.md b/keyboards/wuque/promise87/wkl/readme.md
new file mode 100644
index 0000000000..8629c75291
--- /dev/null
+++ b/keyboards/wuque/promise87/wkl/readme.md
@@ -0,0 +1,29 @@
+# promise87
+
+![Promise87](https://i.imgur.com/0gtouZ2.png)
+
+More Info at [promise87](https://promisetkl.com/)
+​
+
+* Keyboard Maintainer: [spbgzh](https://github.com/spbgzh)
+* Hardware Supported: promise 87
+* Hardware Availability: [promise87](https://promisetkl.com/)
+​
+
+Make example for this keyboard (after setting up your build environment):
+
+ make wuque/promise87/wkl:default
+
+Flashing example for this keyboard:
+
+ make wuque/promise87/wkl:default:flash
+
+## Bootloader
+
+Enter the bootloader using one of the following methods:
+
+* Tap the Reset switch mounted on the PCB
+* In the case of the default keymap, use the key combination Fn + PageUp
+* Hold the Esc key while connecting the USB cable (also erases persistent settings)
+
+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).