summaryrefslogtreecommitdiff
path: root/keyboards/smoll/lefty/readme.md
diff options
context:
space:
mode:
authorSmollChungus <38044391+SmollChungus@users.noreply.github.com>2023-12-08 05:36:38 +0100
committerGitHub <noreply@github.com>2023-12-08 04:36:38 +0000
commit2d3f2e92d82187d3509f4f9be716bb0b31771eb9 (patch)
tree01566e247b6a8646d5048943695a2b08a3999cce /keyboards/smoll/lefty/readme.md
parente394c06d1496a7e0d7581291c0a6cc07f1ff980d (diff)
consolidate firmware folder in smoll parent folder (#22401)
* consolidate firmware folder in smoll parent folder * add moved keyboards to mapping * typo fix * typo.. * Update rules.mk fix default folder lefty * Update data/mappings/keyboard_aliases.hjson Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com> --------- Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com>
Diffstat (limited to 'keyboards/smoll/lefty/readme.md')
-rw-r--r--keyboards/smoll/lefty/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/smoll/lefty/readme.md b/keyboards/smoll/lefty/readme.md
new file mode 100644
index 0000000000..7562517a22
--- /dev/null
+++ b/keyboards/smoll/lefty/readme.md
@@ -0,0 +1,27 @@
+# lefty
+
+![lefty](https://i.imgur.com/nMmJCJMh.jpeg)
+
+Half an alice used as a macropad.
+
+* Keyboard Maintainer: [SmollChungus](https://github.com/smollchungus/)
+
+* Hardware Supported: Lefty PCB rev1 and rev2
+
+Make example for this keyboard (after setting up your build environment):
+
+ make lefty:default
+
+Flashing example for this keyboard:
+
+ make lefty: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