summaryrefslogtreecommitdiff
path: root/keyboards/whitefacemountain/ampersand/readme.md
diff options
context:
space:
mode:
authorNick Brassel <nick@tzarc.org>2024-08-26 10:01:57 +1000
committerNick Brassel <nick@tzarc.org>2024-08-26 10:01:57 +1000
commit5d76c5280dc0aff398cdce19fa54d0e0725c418d (patch)
tree40026340f0d524a6006f18f01ef988e15d271075 /keyboards/whitefacemountain/ampersand/readme.md
parente6a898e3eea3521d3f0497ee26937d5269d78fb7 (diff)
parent81dcf2b547bacc42bd9cf8ccaccd3d7164e69926 (diff)
Merge branch 'develop'0.26.0
Diffstat (limited to 'keyboards/whitefacemountain/ampersand/readme.md')
-rw-r--r--keyboards/whitefacemountain/ampersand/readme.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/keyboards/whitefacemountain/ampersand/readme.md b/keyboards/whitefacemountain/ampersand/readme.md
new file mode 100644
index 0000000000..d85f82d6fb
--- /dev/null
+++ b/keyboards/whitefacemountain/ampersand/readme.md
@@ -0,0 +1,28 @@
+# Ampersand
+
+![Ampersand](https://i.imgur.com/jbr7Bld.png)
+
+Ampersand is a gummyworm mounted 13.5u keyboard with minimum 40s support needed.
+Its frosted polycarbonate case and blasted brass weight will pair well with most keysets, with greater compatibility than most 40s.
+
+* Keyboard Maintainer: [roarmstrong](https://github.com/roarmstrong)
+* Hardware Supported: Ampersand custom PCB, using Atmega32u4
+* Hardware Availability: [Coffee Break Keyboards](https://www.cbkbd.com/product/ampersand), [Keeb Supply](https://keeb.supply/products/ampersand)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make whitefacemountain/ampersand:default
+
+Flashing example for this keyboard:
+
+ make whitefacemountain/ampersand: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 (the top left key) and plug in the keyboard
+* **Physical reset button**: Briefly press the button labelled SW1 on the back of the PCB
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available