diff --git a/README.md b/README.md new file mode 100644 index 0000000..7f8a03d --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# TiTux badge + +![TiTux badge](./artwork/readme-header.jpg) + +## board + +The board is designed in KiCad and uses a dual sided pcb while only using one side for the components. It features an ATtiny84 with 6 LEDs and a switch powered by a 3 V button cell. The example above was manufactured by [OSH Park]. + +## code + +The challenge is to come up with your own interesting light shows, games, etc. for the badge. This repo includes a basic Arduino sketch using the [ATTinyCore] to get you started. + +Use some crocodile clips and an AVR ISP programmer like a standard Arduino UNO with the [ISP sketch] and a 10 μF capacitor. + +## licence + +The design and example firmware are licenced under `GPL-3.0-or-later`. + +[OSH Park]: https://oshpark.com/ +[ATTinyCore]: https://github.com/SpenceKonde/ATTinyCore +[ISP sketch]: https://www.arduino.cc/en/tutorial/arduinoISP \ No newline at end of file diff --git a/artwork/readme-header.jpg b/artwork/readme-header.jpg new file mode 100644 index 0000000..e31fa76 Binary files /dev/null and b/artwork/readme-header.jpg differ