summaryrefslogtreecommitdiff
path: root/keyboards/smallkeyboard/readme.md
diff options
context:
space:
mode:
authorQMK Bot <hello@qmk.fm>2021-09-21 22:53:09 +0000
committerQMK Bot <hello@qmk.fm>2021-09-21 22:53:09 +0000
commitdd115fd50e967e2cd5a2d0657cb1359c63f1123d (patch)
treeb975918318cc15e9768d587b30978e4d4c6a8321 /keyboards/smallkeyboard/readme.md
parent8b6c16ea1f5fa982f32560eade897dcf856fbbbd (diff)
parentbb754069e95237bec69cc23845e2515eea5f33e4 (diff)
downloadqmk_firmware-dd115fd50e967e2cd5a2d0657cb1359c63f1123d.tar.gz
qmk_firmware-dd115fd50e967e2cd5a2d0657cb1359c63f1123d.zip
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'keyboards/smallkeyboard/readme.md')
-rw-r--r--keyboards/smallkeyboard/readme.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/keyboards/smallkeyboard/readme.md b/keyboards/smallkeyboard/readme.md
new file mode 100644
index 0000000000..54b4bcb532
--- /dev/null
+++ b/keyboards/smallkeyboard/readme.md
@@ -0,0 +1,18 @@
+# SMALLKEYBOARD
+
+![](https://github.com/zhouqiong19840119/MacroKeyboard-little/blob/main/Small%20(1).jpg)
+
+* Keyboard Maintainer: [zhouqiong19840119](https://github.com/zhouqiong19840119)
+* Hardware Availability:
+
+Make example for this keyboard (after setting up your build environment):
+
+ make smallkeyboard:default
+
+Flashing example for this keyboard:
+
+ make smallkeyboard:default:flash
+
+To reset the board into bootloader mode, hold the key at the top left of the keyboard 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).