summaryrefslogtreecommitdiff
path: root/keyboards/smallkeyboard/readme.md
diff options
context:
space:
mode:
authorzhouqiong19840119 <82140728+zhouqiong19840119@users.noreply.github.com>2021-09-22 06:52:39 +0800
committerGitHub <noreply@github.com>2021-09-21 15:52:39 -0700
commitbb754069e95237bec69cc23845e2515eea5f33e4 (patch)
tree50332fd6b6394e02f6a780e1363ac4b98392624c /keyboards/smallkeyboard/readme.md
parent32a96be09321870e7d7d084c893dee599e47132b (diff)
downloadqmk_firmware-bb754069e95237bec69cc23845e2515eea5f33e4.tar.gz
qmk_firmware-bb754069e95237bec69cc23845e2515eea5f33e4.zip
[Keyboard] smallkeyboard support (#12817)
Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com> Co-authored-by: Drashna Jaelre <drashna@live.com>
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).