summaryrefslogtreecommitdiff
path: root/keyboards/wuque/mammoth20x/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/wuque/mammoth20x/readme.md')
-rw-r--r--keyboards/wuque/mammoth20x/readme.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/keyboards/wuque/mammoth20x/readme.md b/keyboards/wuque/mammoth20x/readme.md
new file mode 100644
index 0000000000..4b731a159c
--- /dev/null
+++ b/keyboards/wuque/mammoth20x/readme.md
@@ -0,0 +1,22 @@
+# mammoth20x
+​
+More Info at[wuquestudio](https://shop.wuquestudio.com/).
+​
+* Keyboard Maintainer: [spbgzh](https://github.com/spbgzh)
+* Hardware Supported: mammoth20x Standard
+* Hardware Availability: [mammoth20x](https://shop.wuquestudio.com/)
+​
+Make example for this keyboard (after setting up your build environment):
+
+ make wuque/mammoth20x:default
+
+Flashing example for this keyboard:
+
+ make wuque/mammoth20x:default:flash
+
+To reset the board into bootloader mode, do one of the following:
+
+* Tap the Reset switch mounted on the PCB
+* 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).