aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authortslil clingman <>2021-09-29 14:33:21 -0400
committertslil clingman <>2021-09-29 14:33:21 -0400
commit328474f555ab0958e0921c7d04d8d7dbb1789bc4 (patch)
tree422a4afe050471fde632d6075a983f7d588ea829 /README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5ea2ad2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# Art Deco Clock
+
+![3D Render](adclock.png)
+![Real life](printed.jpg)
+
+## Ingredients
+
+* ATTiny24
+* DS1302 RTC module
+* 2 OLED screens
+* 2 buttons
+* female USB breakout board for power
+
+Edit `code/src/main.c` to reflect your choice of wiring, and then run
+`make summary` to generate a hex file, and `make upload` if you happen
+to be using a USBASP programmer.
+
+## License
+
+Gnu GPL v3
+
+The code makes use of Tiny I2C by David Johnson-Davies -
+www.technoblogy.com. This library is CC BY 4.0.