summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c8b3080
--- /dev/null
+++ b/README.md
@@ -0,0 +1,38 @@
+# geebord
+> geeboard @ orangerot.dev // through the keyboard our ghosts rule the machine_
+
+40% ortholinear mechanical diy keyboard with a thumbstick and qmk firmware.
+
+## Features
+
+- trackpoint-style thumbstick as pointing device (JKL as Mousebuttons);
+- 40% formfactor to just barely fit in a pocket for the nintedo switch - it
+ surely has at least one switch inside :)
+- ortholinear layout
+- QMK Firmware
+
+## Bill of Materials
+
+- ` 1x` Adafruit KB2040 - RP2040 Kee Boar Driver
+- ` 1x` Adafruit Mini 2-Axis Analog Thumbstick
+- `46x` Kailh Switch Sockets for MX-compatible Mechanical Keys
+- `46x` 1N4148 Diode
+- ` 4x` M3 Screws of 24mm
+- ` 4x` M3 Flange Nut
+- 3mm Acrylic Sheet to fit 4 parts of 24x9cm
+- 1mm Felt to fit 2 parts of 24x9cm
+- Angled USB-C Cable
+- Nintendo Switch Case
+
+## PCB Settings
+
+| Setting | PCB | Plate |
+| --- | --- | --- |
+| Thickness | 1.2mm | 1.6mm |
+
+
+
+## License
+
+The hardware is licensed under the CERN-OHL-S-v2 License while the firmware is
+licensed under the GPLv3 License - see the `LICENSE` files for details