summaryrefslogtreecommitdiff
path: root/keyboards/lfkeyboards/mini1800/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/lfkeyboards/mini1800/readme.md')
-rw-r--r--keyboards/lfkeyboards/mini1800/readme.md28
1 files changed, 21 insertions, 7 deletions
diff --git a/keyboards/lfkeyboards/mini1800/readme.md b/keyboards/lfkeyboards/mini1800/readme.md
index e2839275cc..4e35ac537e 100644
--- a/keyboards/lfkeyboards/mini1800/readme.md
+++ b/keyboards/lfkeyboards/mini1800/readme.md
@@ -1,12 +1,26 @@
-Mini1800
-===
+# Mini1800
-Keyboard Maintainer: [LFKeyboards](https://github.com/lfkeyboards)
-Hardware Supported: Mini1800
-Hardware Availability: [LFKeyboards.com](https://www.lfkeyboards.com/)
+* Keyboard Maintainer: [LFKeyboards](https://github.com/lfkeyboards)
+* Hardware Supported:
+ * [Mini1800 RevA](reva/) - Green PCB with AT90USB1286
+ * [Mini1800 RevC](revc/) - Black PCB with AT90USB646; first public release
+* Hardware Availability: [LFKeyboards.com](https://www.lfkeyboards.com/)
Make example for this keyboard (after setting up your build environment):
- make lfkeyboards/mini1800:default
+ make lfkeyboards/mini1800/reva:default
+ make lfkeyboards/mini1800/revc:default
-See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information.
+Flashing example for this keyboard:
+
+ make lfkeyboards/mini1800/reva:default:flash
+ make lfkeyboards/mini1800/revc:default:flash
+
+## Bootloader
+
+To reset the board into bootloader mode, do one of the following:
+
+* **Physical reset button**: Briefly press the button on the bottom of the PCB (between Q and W keys)
+* **Keycode in keymap**: Press the key mapped to `RESET` if it is available (`Fn`+`Right Shift`, then tap `Enter` by default)
+
+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).