Merge branch 'master' of github.com:Jan--Henrik/IBM-dials-retrofit

2 files changed, 23 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
+
diff --git a/hid-dials/README.md b/hid-dials/README.md
new file mode 100644
index 0000000..848d749
--- /dev/null
+++ b/hid-dials/README.md
@@ -0,0 +1,17 @@
+# HID implementation for IBM-dials-retrofit
+
+Works, currently hardcoded:
+
+ - Dial 1: Volume Up/Down
+ - Dial 2: nothing
+ - Dial 3: KiCAD switch layer (v)
+ - Dial 4: KiCAD rotate part (r|R)
+ - Dial 5: KiCAD change grid settings (n|N)
+ - Dial 6: nothing
+ - Dial 7: KiCAD change track width (w|W)
+ - Dial 8: KiCAD zoom (+|-)
+ 
+ Todo:
+ 
+  [ ] Add filesystem and csv alike config files
+