summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJan Henrik <janhenrik@janhenrik.org>2020-04-01 01:22:00 +0200
committerGitHub <noreply@github.com>2020-04-01 01:22:00 +0200
commit462d79e7d9b27ebf839439f413752b2c3b2127f3 (patch)
tree72c90c79090c8d59f2c42465eb067f34a7b852bb /README.md
parentff82e6358058924a7bc92bcfcdb3aece48faf08e (diff)
downloadminikbd-462d79e7d9b27ebf839439f413752b2c3b2127f3.tar.gz
minikbd-462d79e7d9b27ebf839439f413752b2c3b2127f3.tar.bz2
minikbd-462d79e7d9b27ebf839439f413752b2c3b2127f3.zip
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 6 insertions, 1 deletions
diff --git a/README.md b/README.md
index 091c661..cb3e88e 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,12 @@
# IBM-dials-retrofit
-Software and hardware instructions to retrofit your IBM Dials :3
+This repo contains the firmware and hardware instructions to retrofit your *IBM Dials* with a full-speed USB interface, cabable of CDC, MIDI and HID. The mod uses an OtterPill, a STM32F072 devboard featuring USB-PD. This feature however is not needed and the PD-phy should be replaced with two 5.1k-ohm resistors. Additionally an IBM Dials and a 3D printed Otter-Pill mount is needed.
+
+The firmware on the OtterPill can be customized and used for a variety of applications, e.g. [KiCAD](https://twitter.com/JanHenrikH/status/1245113168621449217).
**Documentation is WIP**
![](images/1.jpeg)
+
+## Building instructions
+