summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGuillaume Pinot <guillaume.pinot@citodi.fr>2020-08-30 21:20:33 +0200
committerGuillaume Pinot <guillaume.pinot@citodi.fr>2020-08-30 21:26:31 +0200
commitee2df03d55aea60e6a9fe2b634a07278f5553411 (patch)
treec519f2cff990a78f688bc68022083ef31900e519 /README.md
parent06f5c7f9ce96ce7d36cb370400ea54db9ad7d6cb (diff)
Images and updates of the md files
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 17 insertions, 5 deletions
diff --git a/README.md b/README.md
index cc3c0b0..07c3a06 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,20 @@
# KeySeeBee
-KeySeeBee is a split ergo keyboard. It is only 2 PCB (so the name) with (almost) only SMD components on it. It's only a keyboard, no LED, no display, nothing more than keys and USB.
+![KeySeeBee](images/keyseebee.jpg)
-The firmware is [Keyberon](https://github.com/TeXitoi/keyberon), a pure rust firmware.
+KeySeeBee is a split ergo keyboard. It is only 2 PCB (so the name)
+with (almost) only SMD components on it. It's only a keyboard, no LED,
+no display, nothing more than keys and USB.
+
+The firmware is [Keyberon](https://github.com/TeXitoi/keyberon), a
+pure rust firmware.
## Features
* 44 keys, using Cherry MX or Kailh choc switches, only 1U keycaps;
- * USB-C connector on the 2 sides
+ * USB-C connector on the 2 sides;
* TRRS cable for connecting the 2 halves (for power and UART communication between the 2 halves);
- * 2 STM32F072 MCU, with hardware USB bootloader and crystal less USB;
+ * 2 STM32F072 MCU, with hardware USB DFU bootloader and crystal less USB;
* Only onboard SMD component (except for the switches and TRRS connector).
## Inspiration
@@ -17,7 +22,14 @@ The firmware is [Keyberon](https://github.com/TeXitoi/keyberon), a pure rust fir
* [Plaid](https://github.com/hsgw/plaid) for "show the components"
* [GergoPlex](https://www.gboards.ca/product/gergoplex) for "just a keyboard" and "only a PCB with SMD components"
* [Lily58](https://github.com/kata0510/Lily58) for the thumb cluster
- * [Kyria](https://blog.splitkb.com/blog/introducing-the-kyria) for "don't be affraid of pinky stagger"
+ * [Kyria](https://blog.splitkb.com/blog/introducing-the-kyria) for
+ "don't be affraid of pinky stagger"
+
+## Gallery
+
+![From above with one side upside down](images/above-with-back.jpg)
+
+![Side view](images/side-view.jpg)
## Compiling and flashing