summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGuillaume P <TeXitoi@users.noreply.github.com>2020-08-07 18:38:52 +0200
committerGitHub <noreply@github.com>2020-08-07 18:38:52 +0200
commit99422b0144d63f7ceda997056fa94271b3446862 (patch)
treefa740404fc12dfe7b2db3c8bfb3a69385757c65c
parent2d7313ea3d227a11cb5a2a8dc1db08404758481f (diff)
Update README.md
-rw-r--r--README.md19
1 files changed, 18 insertions, 1 deletions
diff --git a/README.md b/README.md
index 6ef0788..f1dcfcf 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,18 @@
-# keyseebee \ No newline at end of file
+# 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.
+
+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
+ * TRRS cable for connecting the 2 halves (for power and UART communication between the 2 halves);
+ * 2 STM32F072 MCU;
+ * Only onboard SMD component (except for the switches and TRRS connector).
+
+Inspiration:
+ * [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"